Commit cbf793fc authored by Andrew Heather's avatar Andrew Heather
Browse files

ENH: Updated header file documentation

parent e9355df1
......@@ -32,10 +32,10 @@ Description
Reference:
\verbatim
Tenneti, S., Garg, R., & Subramaniam, S. (2011).
Drag law for monodisperse gassolid systems using particle-resolved
Drag law for monodisperse gas-solid systems using particle-resolved
direct numerical simulation of flow past fixed assemblies of spheres.
International Journal of Multiphase Flow, 37(9), 10721092.
\verbatim
International Journal of Multiphase Flow, 37(9), 1072-1092.
\endverbatim
SourceFiles
Tenneti.C
......
......@@ -55,10 +55,10 @@ Usage
the resulting dictionary to standard output.
- \par -includes
List the \c #include and \c #includeIfPresent files to standard output
List the \c \#include and \c \#includeIfPresent files to standard output
- \par -disableFunctionEntries
Do not expand macros or directives (#include etc)
Do not expand macros or directives (\#include etc)
Example usage:
- Change simulation to run for one timestep only:
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Namespace
ensightOutput
Foam::ensightOutput
Description
A collection of global functions for writing ensight file content.
......
......@@ -34,7 +34,7 @@ Description
Reference:
\verbatim
Speziale, C. G., Sarkar, S., & Gatski, T. B. (1991).
Modelling the pressurestrain correlation of turbulence:
Modelling the pressure-strain correlation of turbulence:
an invariant dynamical systems approach.
Journal of Fluid Mechanics, 227, 245-272.
\endverbatim
......
......@@ -95,8 +95,7 @@ public:
return ccmIndex != rhs.ccmIndex;
}
// IOstream Operators
//- Ostream Operator
friend Ostream& operator<<(Ostream& os, const ccmBoundaryInfo& entry)
{
os << "BoundaryFaces-" << entry.ccmIndex;
......@@ -107,7 +106,6 @@ public:
return os;
}
};
......
......@@ -85,6 +85,7 @@ Description
D 0.1;
value uniform (0 0 0);
}
\endverbatim
SeeAlso
Foam::fixedValueFvPatchField
......
......@@ -37,8 +37,8 @@ Description
where
\vartable
p_rgh | Pressure - \rho g.(h - hRef) [Pa]
ph_rgh | Hydrostatic pressure - \rho g.(h - hRef) [Pa]
p_rgh | Pressure: \f$ \rho g (h - h_{ref}) \f$ [Pa]
ph_rgh | Hydrostatic pressure: \f$ \rho g (h - h_{ref}) \f$ [Pa]
h | Height in the opposite direction to gravity
hRef | Reference height in the opposite direction to gravity
\rho | Density
......
......@@ -37,7 +37,7 @@ Usage
phi | Flux field name | no | phi
psi | Compressibility field name | no | thermo:psi
gamma | ratio of specific heats (Cp/Cv) | yes |
T0 | reference temperature | yes |
T0 | total temperature | yes |
\endtable
Example of the boundary condition specification:
......@@ -45,7 +45,8 @@ Usage
<patchName>
{
type totalTemperature;
T0 uniform 300;
gamma 1.4;
T0 uniform 800;
}
\endverbatim
......@@ -89,7 +90,7 @@ class totalTemperatureFvPatchScalarField
//- Heat capacity ratio
scalar gamma_;
//- Total pressure
//- Total temperature
scalarField T0_;
......
......@@ -35,7 +35,7 @@ Description
The weight of a blended scheme is given by a function of the blending
factor, f:
\[f
\f[
weight = f scheme1 + (1 - f) scheme2
\f]
......
......@@ -30,6 +30,7 @@ Description
Generates particle size information from Eulerian calculations, e.g. VoF.
Usage
\verbatim
extractEulerianParticles1
{
type extractEulerianParticles;
......
......@@ -42,11 +42,11 @@ Usage
libs ("libfieldFunctionObjects.so");
operation subtract;
source1
region1
{
...
}
source2
region2
{
...
}
......
......@@ -45,6 +45,7 @@ Usage
fields ("U.*" p);
}
\endverbatim
Where the entries comprise:
\table
......
......@@ -91,6 +91,7 @@ Description
// coreBlockageRatio 0;
}
}
\endverbatim
SourceFiles
tabulatedNTUHeatTransfer.C
......
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