Commit 9ce87ca0 authored by Melanie Lipp's avatar Melanie Lipp
Browse files

[doc] Change the positions of ElectroChemistry.pO2Inlet, Grid.CellType and...

[doc] Change the positions of ElectroChemistry.pO2Inlet, Grid.CellType and LoadSolution.PriVarNamesState to where they belong alphabetically.
parent 30549b1e
......@@ -92,6 +92,7 @@
* | ElectroChemistry | CellVoltage | Scalar | - | The voltage of the fuel cell. |
* | ElectroChemistry | MaxIterations | int | - | The maximum number of iterations in iteatively (Newton solver) calculating the current density. |
* | ElectroChemistry | NumElectrons | Scalar | - | The number of electrons for the calculation of activation and concentration losses. |
* | ElectroChemistry | pO2Inlet | Scalar | - | The oxygen pressure at the inlet. |
* | ElectroChemistry | RefCurrentDensity | Scalar | - | The reference current density to calculate the exchange current density. |
* | ElectroChemistry | RefO2PartialPressure | Scalar | - | The reference oxygen partial pressure. |
* | ElectroChemistry | RefTemperature | Scalar | - | The reference temperature to calculate the exchange current density. |
......@@ -101,7 +102,6 @@
* | ElectroChemistry | ThermoneutralVoltage | Scalar | - | Thermoneutral voltage for the non-isothermal electrochemistry model. |
* | ElectroChemistry | TransferCoefficient | Scalar | - | The transport coefficient. |
* | ElectroChemistry | TransportNumberH20 | Scalar | - | The water transport number to calculate the osmotic term in the membrane. |
* | ElectroChemistry | pO2Inlet | Scalar | - | The oxygen pressure at the inlet. |
* | \b FacetCoupling | Xi | Scalar | 1.0 | The xi factor for coupling conditions |
* | \b Flux | DifferencingScheme | std::string | Minmod | Choice of a staggered TVD method |
* | Flux | TvdApproach | std::string | Uniform | If you use a staggered grid with a TVD approach: For a uniform grid "Uniform" is fine. For a nonuniform grid decide between "Li" and "Hou" (two literature-based methods). |
......@@ -117,11 +117,11 @@
* | \b Grid | Angular0/1/2 | std::vector<Scalar> | - | min/max value for angular coordinate. Cake grids can be created by either specifying Radial,Angular or Axial in all coordinate directions. |
* | Grid | Axial0/1/2 | std::vector<Scalar> | - | min/max value for axial coordinate. Cake grids can be created by either specifying Radial,Angular or Axial in all coordinate directions. |
* | Grid | BoundarySegments | bool | false | For the dune gmsh reader: Whether to insert boundary segments into the grid |
* | Grid | CellType | std::string | Cube | "Cube" or "Simplex" to be used for structured grids |
* | Grid | Cells | std::array<int, dim> | - | The number of elements in a structured uniform grid in x, y and z direction |
* | Grid | Cells0 | std::vector<int> | - | For a grid with zones, number of cells of the leftmost zone, number of cells of the second-leftmost zone, ..., number of cells of the rightmost zone, spaceseparated. (assuming x-axis points to the right) |
* | Grid | Cells1 | std::vector<int> | - | Spaceseparated list of the number of cells per zone in y-direction (see more details for x-direction in Cells1). |
* | Grid | Cells2 | std::vector<int> | - | Spaceseparated list of the number of cells per zone in z-direction (see more details for x-direction in Cells1). |
* | Grid | CellType | std::string | Cube | "Cube" or "Simplex" to be used for structured grids |
* | Grid | ClosureType | std::string | Green | Decide whether to add a green closure to locally refined grid sections or not: "Green" (Standard red/green refinement) or "None" (No closure, results in nonconforming meshes) |
* | Grid | Coordinates | std::vector<ctype> | - | To construct a 1D grid with just a coordinates vector |
* | Grid | DomainMarkers | bool | false | Whether the grid managers work with domain markers. |
......@@ -216,9 +216,9 @@
* | \b LoadSolution | CellCenterPriVarNames | std::vector<std::string> | - | Names of cell-centered primary variables of a model with staggered grid discretization |
* | LoadSolution | FacePriVarNames | std::vector<std::string> | - | Names of primary variables on the cell faces of a model with staggered grid discretization |
* | LoadSolution | PriVarNames | std::vector<std::string> | - | Primary variable names |
* | LoadSolution | PriVarNamesState... | std::vector<std::string> | - | Primary variable names state, e.g. p_liq S_gas |
* | LoadSolution | PriVarNamesState1 | std::vector<std::string> | - | Primary variable names state, e.g. p_liq x^N2_liq |
* | LoadSolution | PriVarNamesState2 | std::vector<std::string> | - | Primary variable names state, e.g. p_liq x^H2O_gas |
* | LoadSolution | PriVarNamesState... | std::vector<std::string> | - | Primary variable names state, e.g. p_liq S_gas |
* | \b MatrixConverter | DeletePatternEntriesBelowAbsThreshold | Scalar | -1.0 | Only set non-zero value if original matrix entry is larger than this. |
* | \b MixedDimension | IntegrationOrder | int | 1 | The integration order for coupling source |
* | MixedDimension | KernelIntegrationCRL | double | 0.1 | The characteristic relative length |
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment