.FCSys.UsersGuide.GettingStarted

Information

These are the suggested steps to begin using FCSys:

1. Read the overview in the top-level documentation.
2. Browse the subpackages of FCSys. In general, the subpackages are ordered with high-level models at the top and basic classes at the bottom.
3. Call FCSys.Units.setup() to establish the display units. This is automatic if FCSys is loaded via the load.mos script.
4. Simulate the FCSys.Assemblies.Cells.Examples.TestStand model. There are scripts in Resources/Scripts/Dymola/ to create useful plots of that model and others. The scripts should be accessible from the "Command" menu of the Modelica development environment. For more detailed analysis, a Python module called FCRes is available in Resources/Source/Python/ (HTML and PDF documentation here and here).
5. Read the documentation of the classes. In particular, these may be of interest:
   • FCSys.Units package: Information about the system of units, which is different than Modelica.SIunits
   • FCSys.Connectors package: Overview of the connectors
   • FCSys.Species.Species model: Details about the storage and transfer of material, momentum, and energy
   • FCSys.Regions.AnFPs.AnFP model: Information about the geometric orientation of the cell
   In general, overviews are given in the documentation of containing packages and detailed information is given at the appropriate level of inheritance. If a class does not have sufficient documentation, please look at its base class(es) and the package(s) that contain it. Assumptions are only listed at the lowest level of inheritance at which they apply. Therefore, the list of assumptions in a model should be considered in conjunction with the assumptions in all the models it inherits from.
6. Create and simulate examples of other applications and scenarios. Many of the submodels (regions, subregions, species) are replaceable. Their parameters are often not propagated to the cell level, but may be edited via the parameter dialog by accessing the submodel. Note that many models have auxiliary output variables for analysis and diagnostics. These may be included by setting analysis=true in the outer environment model (instance of Environment).
7. Develop your own classes. It should be possible to model other fluidic or electrochemical devices (solid oxide fuel cells, lithium ion batteries, flow batteries/regenerative fuel cells, etc.) by extending the existing classes and following the existing framework. It will be necessary to add species models (Li⁺, O^2-, etc.).
8. Please share your additions or modifications to the source code so that the library can be improved and others may benefit. The best way is to create a fork from the development page at https://github.com/kdavies4/FCSys. Please also use the contact information.