Commit 71fdcab7 authored by Henry Weller's avatar Henry Weller
Browse files

Updated header documentation processed by Doxygen

parent 0c62c8e1
......@@ -45,7 +45,6 @@ Description
Usage
\table
Property | Description | Required | Default value
p | Pressure field name | no | p
......@@ -54,7 +53,7 @@ Usage
Example of the boundary condition specification:
\verbatim
myPatch
<patchName>
{
type fixedRho;
}
......
......@@ -34,7 +34,6 @@ Description
the Eulerian multiphase solvers.
Usage
\table
Property | Description | Required | Default value
Prt | Turbulent Prandtl number | no | 0.85
......@@ -45,7 +44,7 @@ Usage
Example of the boundary condition specification:
\verbatim
myPatch
<patchName>
{
type alphatPhaseChangeJayatillekeWallFunction;
Prt 0.85;
......
......@@ -427,7 +427,7 @@
\verbatim
patchName
{
type myPatchType;
type patchType;
refValue 100;
value uniform 1;
}
......
......@@ -44,7 +44,6 @@ Description
\endtable
Usage
\table
Property | Description | Req'd? | Default
scalarData | single scalar value | yes |
......@@ -56,7 +55,7 @@ Usage
Example of the boundary condition specification:
\verbatim
myPatch
<patchName>
{
type NAME;
scalarData -1;
......
......@@ -42,10 +42,10 @@ Description
\verbatim
functions
{
myFunctionObject // Name of functionObject entry
<functionObjectName>
{
type functionObjectType;
libs ("libMyFunctionObjectlib.so");
libs ("libMyFunctionObjectlib.so");
region defaultRegion;
enabled yes;
timeStart 0;
......@@ -84,12 +84,12 @@ Description
none | Execute/write every time-step
\endtable
The sub-dictionary name \c myFunctionObject is chosen by the user, and is
typically used as the name of the output directory for any data written by
the functionObject. The \c type entry defines the type of function object
properties that follow. FunctionObjects are packaged into separate
libraries and the \c libs entry is used to specify which library
should be loaded.
The sub-dictionary name \c <functionObjectName> is chosen by the user, and
is typically used as the name of the output directory for any data written
by the functionObject. The \c type entry defines the type of function
object properties that follow. FunctionObjects are packaged into separate
libraries and the \c libs entry is used to specify which library should be
loaded.
Class
Foam::functionObject
......
......@@ -51,7 +51,6 @@ Description
\endvartable
Usage
\table
Property | Description | Required | Default value
L | Length scale [m] | yes |
......@@ -59,7 +58,7 @@ Usage
Example of the boundary condition specification:
\verbatim
myPatch
<patchName>
{
type convectiveHeatTransfer;
L 0.1;
......
......@@ -84,7 +84,6 @@ Description
Usage
\table
Property | Description | Required | Default value
commsDir | communications directory | yes |
......@@ -97,7 +96,7 @@ Usage
Example of the boundary condition specification:
\verbatim
myPatch
<patchName>
{
type externalCoupledTemperature;
commsDir "$FOAM_CASE/comms";
......
......@@ -49,7 +49,6 @@ Description
thermophysical package.
Usage
\table
Property | Description | Required | Default value
kappa | thermal conductivity option | yes |
......@@ -65,7 +64,7 @@ Usage
Example of the boundary condition specification:
\verbatim
myPatch
<patchName>
{
type externalWallHeatFluxTemperature;
kappa fluidThermo;
......
......@@ -28,23 +28,22 @@ Group
grpThermoBoundaryConditions
Description
This BC solves a steady 1D thermal baffle.
This BC solves a steady 1D thermal baffle. The solid properties are
specify as dictionary. Optionaly radiative heat flux (Qr) can be
incorporated into the balance. Some under-relaxation might be needed on
Qr.
Baffle and solid properties need to be specified on the master side
of the baffle.
The solid properties are specify as dictionary. Optionaly radiative heat
flux (Qr) can be incorporated into the balance. Some under-relaxation might
be needed on Qr. Baffle and solid properties need to be specified on the
master side of the baffle.
Usage
Example of the boundary condition specification using constant
solid thermo :
\verbatim
myPatch_master
<masterPatchName>
{
type compressible::thermalBaffle1D<hConstSolidThermoPhysics>;
samplePatch myPatch_slave;
samplePatch <slavePatchName>;
thickness uniform 0.005; // thickness [m]
Qs uniform 100; // heat flux [W/m2]
......@@ -75,18 +74,16 @@ Usage
value uniform 300;
}
myPatch_slave
<slavePatchName>
{
type compressible::thermalBaffle1D<hConstSolidThermoPhysics>;
samplePatch myPatch_master_master;
samplePatch <masterPatchName>;
Qr none;
relaxation 1;
}
\endverbatim
SourceFiles
thermalBaffle1DFvPatchScalarField.C
......@@ -131,7 +128,7 @@ class thermalBaffle1DFvPatchScalarField
mutable scalarField Qs_;
//- Solid dictionary
dictionary solidDict_;
dictionary solidDict_;
//- Solid thermo
mutable autoPtr<solidType> solidPtr_;
......
......@@ -30,7 +30,6 @@ Description
flux [W/m^2].
Usage
\table
Property | Description | Required | Default value
heatSource | 'power' [W] or 'flux' [W/m^2] | yes |
......
......@@ -43,7 +43,6 @@ Description
where KDelta is heat-transfer coefficient K * deltaCoeffs
Usage
\table
Property | Description | Required | Default value
kappa | thermal conductivity option | yes |
......@@ -55,7 +54,7 @@ Usage
Example of the boundary condition specification:
\verbatim
myPatch
<patchName>
{
type compressible::turbulentTemperatureCoupledBaffleMixed;
Tnbr T;
......
......@@ -36,7 +36,6 @@ Description
or \c fluidThermo thermophysical package.
Usage
\table
Property | Description | Required | Default value
kappa | thermal conductivity option | yes |
......@@ -50,7 +49,7 @@ Usage
Example of the boundary condition specification:
\verbatim
myPatch
<patchName>
{
type compressible::turbulentTemperatureRadCoupledMixed;
Tnbr T;
......
......@@ -32,7 +32,6 @@ Description
thermal diffusivity (usually\c alphat) based on the Jayatilleke model.
Usage
\table
Property | Description | Required | Default value
Prt | turbulent Prandtl number | no | 0.85
......@@ -43,7 +42,7 @@ Usage
Example of the boundary condition specification:
\verbatim
myPatch
<patchName>
{
type alphatJayatillekeWallFunction;
Prt 0.85;
......
......@@ -47,7 +47,6 @@ Description
\endvartable
Usage
\table
Property | Description | Required | Default value
nut | turbulence viscosity field name | no | nut
......@@ -56,7 +55,7 @@ Usage
Example of the boundary condition specification:
\verbatim
myPatch
<patchName>
{
type alphatWallFunction;
nut nut;
......
......@@ -32,7 +32,6 @@ Description
transfer
Usage
\table
Property | Description | Required | Default value
Tinf | wall temperature | yes |
......@@ -41,7 +40,7 @@ Usage
Example of the boundary condition specification:
\verbatim
myPatch
<patchName>
{
type wallHeatTransfer;
Tinf uniform 500;
......
......@@ -32,7 +32,6 @@ Description
for using wall functions, using the Jayatilleke 'P' function.
Usage
\table
Property | Description | Required | Default value
Prt | turbulent Prandtl number | no | 0.85
......@@ -43,7 +42,7 @@ Usage
Example of the boundary condition specification:
\verbatim
myPatch
<patchName>
{
type alphatJayatillekeWallFunction;
}
......
......@@ -75,7 +75,6 @@ Description
95(2007), pp 355-369.
Usage
\table
Property | Description | Required | Default
flowDir | Flow direction | yes |
......
......@@ -46,7 +46,6 @@ Description
\endvartable
Usage
\table
Property | Description | Required | Default value
mixingLength | Length scale [m] | yes |
......@@ -56,7 +55,7 @@ Usage
Example of the boundary condition specification:
\verbatim
myPatch
<patchName>
{
type turbulentMixingLengthDissipationRateInlet;
mixingLength 0.005;
......
......@@ -46,7 +46,6 @@ Description
\endvartable
Usage
\table
Property | Description | Required | Default value
mixingLength | Length scale [m] | yes |
......@@ -56,7 +55,7 @@ Usage
Example of the boundary condition specification:
\verbatim
myPatch
<patchName>
{
type turbulentMixingLengthFrequencyInlet;
mixingLength 0.005;
......
......@@ -50,7 +50,6 @@ Description
Usage
\table
Property | Description | Required | Default value
patchType | underlying patch type should be \c cyclic| yes |
......@@ -63,7 +62,7 @@ Usage
Example of the boundary condition specification:
\verbatim
myPatch
<patchName>
{
type porousBafflePressure;
patchType cyclic;
......
Markdown is supported
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