Updated header documentation processed by Doxygen

This commit is contained in:
Henry Weller
2016-06-19 21:23:54 +01:00
parent 62e340f56c
commit 9f67acdc53
162 changed files with 214 additions and 361 deletions

View File

@ -45,7 +45,6 @@ Description
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
p | Pressure field name | no | p p | Pressure field name | no | p
@ -54,7 +53,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fixedRho; type fixedRho;
} }

View File

@ -34,7 +34,6 @@ Description
the Eulerian multiphase solvers. the Eulerian multiphase solvers.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
Prt | Turbulent Prandtl number | no | 0.85 Prt | Turbulent Prandtl number | no | 0.85
@ -45,7 +44,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type alphatPhaseChangeJayatillekeWallFunction; type alphatPhaseChangeJayatillekeWallFunction;
Prt 0.85; Prt 0.85;

View File

@ -427,7 +427,7 @@
\verbatim \verbatim
patchName patchName
{ {
type myPatchType; type patchType;
refValue 100; refValue 100;
value uniform 1; value uniform 1;
} }

View File

@ -44,7 +44,6 @@ Description
\endtable \endtable
Usage Usage
\table \table
Property | Description | Req'd? | Default Property | Description | Req'd? | Default
scalarData | single scalar value | yes | scalarData | single scalar value | yes |
@ -56,7 +55,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type NAME; type NAME;
scalarData -1; scalarData -1;

View File

@ -42,10 +42,10 @@ Description
\verbatim \verbatim
functions functions
{ {
myFunctionObject // Name of functionObject entry <functionObjectName>
{ {
type functionObjectType; type functionObjectType;
libs ("libMyFunctionObjectlib.so"); libs ("libMyFunctionObjectlib.so");
region defaultRegion; region defaultRegion;
enabled yes; enabled yes;
timeStart 0; timeStart 0;
@ -84,12 +84,12 @@ Description
none | Execute/write every time-step none | Execute/write every time-step
\endtable \endtable
The sub-dictionary name \c myFunctionObject is chosen by the user, and is The sub-dictionary name \c <functionObjectName> is chosen by the user, and
typically used as the name of the output directory for any data written by is typically used as the name of the output directory for any data written
the functionObject. The \c type entry defines the type of function object by the functionObject. The \c type entry defines the type of function
properties that follow. FunctionObjects are packaged into separate object properties that follow. FunctionObjects are packaged into separate
libraries and the \c libs entry is used to specify which library libraries and the \c libs entry is used to specify which library should be
should be loaded. loaded.
Class Class
Foam::functionObject Foam::functionObject

View File

@ -51,7 +51,6 @@ Description
\endvartable \endvartable
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
L | Length scale [m] | yes | L | Length scale [m] | yes |
@ -59,7 +58,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type convectiveHeatTransfer; type convectiveHeatTransfer;
L 0.1; L 0.1;

View File

@ -84,7 +84,6 @@ Description
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
commsDir | communications directory | yes | commsDir | communications directory | yes |
@ -97,7 +96,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type externalCoupledTemperature; type externalCoupledTemperature;
commsDir "$FOAM_CASE/comms"; commsDir "$FOAM_CASE/comms";

View File

@ -49,7 +49,6 @@ Description
thermophysical package. thermophysical package.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
kappa | thermal conductivity option | yes | kappa | thermal conductivity option | yes |
@ -65,7 +64,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type externalWallHeatFluxTemperature; type externalWallHeatFluxTemperature;
kappa fluidThermo; kappa fluidThermo;

View File

@ -28,23 +28,22 @@ Group
grpThermoBoundaryConditions grpThermoBoundaryConditions
Description Description
This BC solves a steady 1D thermal baffle.
This BC solves a steady 1D thermal baffle. The solid properties are The solid properties are specify as dictionary. Optionaly radiative heat
specify as dictionary. Optionaly radiative heat flux (Qr) can be flux (Qr) can be incorporated into the balance. Some under-relaxation might
incorporated into the balance. Some under-relaxation might be needed on be needed on Qr. Baffle and solid properties need to be specified on the
Qr. master side of the baffle.
Baffle and solid properties need to be specified on the master side
of the baffle.
Usage Usage
Example of the boundary condition specification using constant Example of the boundary condition specification using constant
solid thermo : solid thermo :
\verbatim \verbatim
myPatch_master <masterPatchName>
{ {
type compressible::thermalBaffle1D<hConstSolidThermoPhysics>; type compressible::thermalBaffle1D<hConstSolidThermoPhysics>;
samplePatch myPatch_slave; samplePatch <slavePatchName>;
thickness uniform 0.005; // thickness [m] thickness uniform 0.005; // thickness [m]
Qs uniform 100; // heat flux [W/m2] Qs uniform 100; // heat flux [W/m2]
@ -75,18 +74,16 @@ Usage
value uniform 300; value uniform 300;
} }
myPatch_slave <slavePatchName>
{ {
type compressible::thermalBaffle1D<hConstSolidThermoPhysics>; type compressible::thermalBaffle1D<hConstSolidThermoPhysics>;
samplePatch myPatch_master_master; samplePatch <masterPatchName>;
Qr none; Qr none;
relaxation 1; relaxation 1;
} }
\endverbatim \endverbatim
SourceFiles SourceFiles
thermalBaffle1DFvPatchScalarField.C thermalBaffle1DFvPatchScalarField.C
@ -131,7 +128,7 @@ class thermalBaffle1DFvPatchScalarField
mutable scalarField Qs_; mutable scalarField Qs_;
//- Solid dictionary //- Solid dictionary
dictionary solidDict_; dictionary solidDict_;
//- Solid thermo //- Solid thermo
mutable autoPtr<solidType> solidPtr_; mutable autoPtr<solidType> solidPtr_;

View File

@ -30,7 +30,6 @@ Description
flux [W/m^2]. flux [W/m^2].
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
heatSource | 'power' [W] or 'flux' [W/m^2] | yes | heatSource | 'power' [W] or 'flux' [W/m^2] | yes |

View File

@ -43,7 +43,6 @@ Description
where KDelta is heat-transfer coefficient K * deltaCoeffs where KDelta is heat-transfer coefficient K * deltaCoeffs
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
kappa | thermal conductivity option | yes | kappa | thermal conductivity option | yes |
@ -55,7 +54,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type compressible::turbulentTemperatureCoupledBaffleMixed; type compressible::turbulentTemperatureCoupledBaffleMixed;
Tnbr T; Tnbr T;

View File

@ -36,7 +36,6 @@ Description
or \c fluidThermo thermophysical package. or \c fluidThermo thermophysical package.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
kappa | thermal conductivity option | yes | kappa | thermal conductivity option | yes |
@ -50,7 +49,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type compressible::turbulentTemperatureRadCoupledMixed; type compressible::turbulentTemperatureRadCoupledMixed;
Tnbr T; Tnbr T;

View File

@ -32,7 +32,6 @@ Description
thermal diffusivity (usually\c alphat) based on the Jayatilleke model. thermal diffusivity (usually\c alphat) based on the Jayatilleke model.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
Prt | turbulent Prandtl number | no | 0.85 Prt | turbulent Prandtl number | no | 0.85
@ -43,7 +42,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type alphatJayatillekeWallFunction; type alphatJayatillekeWallFunction;
Prt 0.85; Prt 0.85;

View File

@ -47,7 +47,6 @@ Description
\endvartable \endvartable
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
nut | turbulence viscosity field name | no | nut nut | turbulence viscosity field name | no | nut
@ -56,7 +55,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type alphatWallFunction; type alphatWallFunction;
nut nut; nut nut;

View File

@ -32,7 +32,6 @@ Description
transfer transfer
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
Tinf | wall temperature | yes | Tinf | wall temperature | yes |
@ -41,7 +40,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type wallHeatTransfer; type wallHeatTransfer;
Tinf uniform 500; Tinf uniform 500;

View File

@ -32,7 +32,6 @@ Description
for using wall functions, using the Jayatilleke 'P' function. for using wall functions, using the Jayatilleke 'P' function.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
Prt | turbulent Prandtl number | no | 0.85 Prt | turbulent Prandtl number | no | 0.85
@ -43,7 +42,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type alphatJayatillekeWallFunction; type alphatJayatillekeWallFunction;
} }

View File

@ -75,7 +75,6 @@ Description
95(2007), pp 355-369. 95(2007), pp 355-369.
Usage Usage
\table \table
Property | Description | Required | Default Property | Description | Required | Default
flowDir | Flow direction | yes | flowDir | Flow direction | yes |

View File

@ -46,7 +46,6 @@ Description
\endvartable \endvartable
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
mixingLength | Length scale [m] | yes | mixingLength | Length scale [m] | yes |
@ -56,7 +55,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type turbulentMixingLengthDissipationRateInlet; type turbulentMixingLengthDissipationRateInlet;
mixingLength 0.005; mixingLength 0.005;

View File

@ -46,7 +46,6 @@ Description
\endvartable \endvartable
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
mixingLength | Length scale [m] | yes | mixingLength | Length scale [m] | yes |
@ -56,7 +55,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type turbulentMixingLengthFrequencyInlet; type turbulentMixingLengthFrequencyInlet;
mixingLength 0.005; mixingLength 0.005;

View File

@ -50,7 +50,6 @@ Description
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
patchType | underlying patch type should be \c cyclic| yes | patchType | underlying patch type should be \c cyclic| yes |
@ -63,7 +62,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type porousBafflePressure; type porousBafflePressure;
patchType cyclic; patchType cyclic;

View File

@ -39,7 +39,6 @@ Description
switch-over y+ value derived from kappa and E. switch-over y+ value derived from kappa and E.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
Cmu | model coefficient | no | 0.09 Cmu | model coefficient | no | 0.09
@ -49,7 +48,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type epsilonLowReWallFunction; type epsilonLowReWallFunction;
} }

View File

@ -44,7 +44,6 @@ Description
\endvartable \endvartable
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
Cmu | model coefficient | no | 0.09 Cmu | model coefficient | no | 0.09
@ -54,7 +53,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type epsilonWallFunction; type epsilonWallFunction;
} }

View File

@ -35,7 +35,6 @@ Description
switch-over y+ value derived from kappa and E. switch-over y+ value derived from kappa and E.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
Cmu | model coefficient | no | 0.09 Cmu | model coefficient | no | 0.09
@ -45,7 +44,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fWallFunction; type fWallFunction;
} }

View File

@ -35,7 +35,6 @@ Description
switch-over y+ value derived from kappa and E. switch-over y+ value derived from kappa and E.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
Cmu | model coefficient | no | 0.09 Cmu | model coefficient | no | 0.09
@ -46,7 +45,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type kLowReWallFunction; type kLowReWallFunction;
} }

View File

@ -35,10 +35,9 @@ Description
It is a simple wrapper around the zero-gradient condition. It is a simple wrapper around the zero-gradient condition.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type kqRWallFunction; type kqRWallFunction;
} }

View File

@ -33,10 +33,9 @@ Description
provides an access function to calculate y+. provides an access function to calculate y+.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type nutLowReWallFunction; type nutLowReWallFunction;
} }

View File

@ -32,7 +32,6 @@ Description
when using wall functions for rough walls, based on velocity. when using wall functions for rough walls, based on velocity.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
roughnessHeight | roughness height | yes | roughnessHeight | roughness height | yes |
@ -42,7 +41,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type nutURoughWallFunction; type nutURoughWallFunction;
roughnessHeight 1e-5; roughnessHeight 1e-5;

View File

@ -46,10 +46,9 @@ Description
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type nutUSpaldingWallFunction; type nutUSpaldingWallFunction;
} }

View File

@ -34,7 +34,6 @@ Description
located in the $FOAM_CASE/constant directory. located in the $FOAM_CASE/constant directory.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
uPlusTable | U+ as a function of Re table name | yes | uPlusTable | U+ as a function of Re table name | yes |
@ -42,7 +41,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type nutTabulatedWallFunction; type nutTabulatedWallFunction;
uPlusTable myUPlusTable; uPlusTable myUPlusTable;

View File

@ -32,10 +32,9 @@ Description
when using wall functions, based on velocity. when using wall functions, based on velocity.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type nutUWallFunction; type nutUWallFunction;
} }

View File

@ -33,7 +33,6 @@ Description
- replicates OpenFOAM v1.5 (and earlier) behaviour - replicates OpenFOAM v1.5 (and earlier) behaviour
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
Cmu | Cmu coefficient | no | 0.09 Cmu | Cmu coefficient | no | 0.09
@ -43,7 +42,7 @@ Usage
Examples of the boundary condition specification: Examples of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type nutWallFunction; type nutWallFunction;
value uniform 0.0; value uniform 0.0;

View File

@ -47,7 +47,6 @@ Description
\endvartable \endvartable
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
z0 | surface roughness length| yes | z0 | surface roughness length| yes |
@ -55,7 +54,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type nutkAtmRoughWallFunction; type nutkAtmRoughWallFunction;
z0 uniform 0; z0 uniform 0;

View File

@ -38,7 +38,6 @@ Description
- roughness constant = 0.5-1.0 - roughness constant = 0.5-1.0
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
Ks | sand-grain roughness height | yes | Ks | sand-grain roughness height | yes |
@ -47,7 +46,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type nutkRoughWallFunction; type nutkRoughWallFunction;
Ks uniform 0; Ks uniform 0;

View File

@ -33,10 +33,9 @@ Description
- replicates OpenFOAM v1.5 (and earlier) behaviour - replicates OpenFOAM v1.5 (and earlier) behaviour
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type nutkWallFunction; type nutkWallFunction;
} }

View File

@ -51,7 +51,6 @@ Description
\endverbatim \endverbatim
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
Cmu | model coefficient | no | 0.09 Cmu | model coefficient | no | 0.09
@ -62,7 +61,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type omegaWallFunction; type omegaWallFunction;
} }

View File

@ -37,7 +37,6 @@ Description
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
Cmu | model coefficient | no | 0.09 Cmu | model coefficient | no | 0.09
@ -47,7 +46,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type v2WallFunction; type v2WallFunction;
} }

View File

@ -47,7 +47,6 @@ Description
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
UInf | freestream velocity | yes | UInf | freestream velocity | yes |
@ -56,7 +55,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type SRFFreestreamVelocity; type SRFFreestreamVelocity;
UInf uniform (0 0 0); UInf uniform (0 0 0);

View File

@ -59,7 +59,6 @@ Description
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
inletValue | inlet velocity | yes | inletValue | inlet velocity | yes |
@ -68,7 +67,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type SRFVelocity; type SRFVelocity;
inletValue uniform (0 0 0); inletValue uniform (0 0 0);

View File

@ -48,10 +48,9 @@ Description
if the wall patch faces are irregular. if the wall patch faces are irregular.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type SRFWallVelocity; type SRFWallVelocity;
value uniform (0 0 0); // Initial value value uniform (0 0 0); // Initial value

View File

@ -33,10 +33,9 @@ Description
e.g. \c updateCoeffs or \c evaluate. e.g. \c updateCoeffs or \c evaluate.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type calculated; type calculated;
value uniform (0 0 0); // Required value entry value uniform (0 0 0); // Required value entry

View File

@ -34,10 +34,9 @@ Description
internal and patch field values rather than returning zero. internal and patch field values rather than returning zero.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type extrapolatedCalculated; type extrapolatedCalculated;
} }

View File

@ -44,7 +44,6 @@ Description
\endvartable \endvartable
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
gradient | gradient | yes | gradient | gradient | yes |
@ -52,7 +51,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fixedGradient; type fixedGradient;
gradient uniform 0; gradient uniform 0;

View File

@ -32,7 +32,6 @@ Description
class for a number of other boundary conditions. class for a number of other boundary conditions.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
value | Patch face values | yes | value | Patch face values | yes |
@ -40,7 +39,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fixedValue; type fixedValue;
value uniform 0; // Example for scalar field usage value uniform 0; // Example for scalar field usage

View File

@ -49,7 +49,6 @@ Description
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
valueFraction | weight field | yes | valueFraction | weight field | yes |

View File

@ -32,10 +32,9 @@ Description
internal field onto the patch faces. internal field onto the patch faces.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type zeroGradient; type zeroGradient;
} }

View File

@ -32,10 +32,9 @@ Description
boundaries. boundaries.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type cyclic; type cyclic;
} }

View File

@ -33,10 +33,9 @@ Description
an arbitrarily coupled mesh interface (ACMI) interpolation. an arbitrarily coupled mesh interface (ACMI) interpolation.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type cyclicACMI; type cyclicACMI;
} }

View File

@ -33,10 +33,9 @@ Description
an arbitrary mesh interface (AMI) interpolation. an arbitrary mesh interface (AMI) interpolation.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type cyclicAMI; type cyclicAMI;
} }

View File

@ -32,10 +32,9 @@ Description
condition, providing no new functionality. condition, providing no new functionality.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type cyclicSlip; type cyclicSlip;
} }

View File

@ -34,10 +34,9 @@ Description
constitue solution directions. constitue solution directions.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type empty; type empty;
} }

View File

@ -31,10 +31,9 @@ Description
This boundary condition enables processor communication across patches. This boundary condition enables processor communication across patches.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type processor; type processor;
} }

View File

@ -32,10 +32,9 @@ Description
patches. patches.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type processor; type processor;
} }

View File

@ -31,10 +31,9 @@ Description
This boundary condition enforces a symmetry constraint This boundary condition enforces a symmetry constraint
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type symmetry; type symmetry;
} }

View File

@ -31,10 +31,9 @@ Description
This boundary condition enforces a symmetryPlane constraint This boundary condition enforces a symmetryPlane constraint
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type symmetryPlane; type symmetryPlane;
} }

View File

@ -32,10 +32,9 @@ Description
it is applied to 2-D geometries. it is applied to 2-D geometries.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type wedge; type wedge;
} }

View File

@ -55,7 +55,6 @@ Description
The open fraction is then applied to scale the patch areas. The open fraction is then applied to scale the patch areas.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
p | pressure field name | no | p p | pressure field name | no | p
@ -68,7 +67,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type activeBaffleVelocity; type activeBaffleVelocity;
p p; p p;

View File

@ -58,7 +58,6 @@ Description
The open fraction is then applied to scale the patch areas. The open fraction is then applied to scale the patch areas.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
p | pressure field name | no | p p | pressure field name | no | p
@ -74,7 +73,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type activePressureForceBaffleVelocity; type activePressureForceBaffleVelocity;
p p; p p;

View File

@ -49,7 +49,6 @@ Description
transmissive boundary condition. transmissive boundary condition.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
phi | flux field name | no | phi phi | flux field name | no | phi
@ -60,7 +59,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type advective; type advective;
phi phi; phi phi;

View File

@ -32,10 +32,9 @@ Description
fixedValueFvPatchField) which is then used to evaluate. fixedValueFvPatchField) which is then used to evaluate.
Usage Usage
Example: Example:
\verbatim \verbatim
myPatch <patchName>
{ {
type codedFixedValue; type codedFixedValue;
value uniform 0; value uniform 0;
@ -63,7 +62,7 @@ Usage
which would have a corresponding entry: which would have a corresponding entry:
\verbatim \verbatim
myPatch <patchName>
{ {
code code
#{ #{

View File

@ -32,10 +32,9 @@ Description
mixedFvPatchField) which is then used to evaluate. mixedFvPatchField) which is then used to evaluate.
Usage Usage
Example: Example:
\verbatim \verbatim
myPatch <patchName>
{ {
type codedMixed; type codedMixed;
@ -71,7 +70,7 @@ Usage
which would have a corresponding entry which would have a corresponding entry
\verbatim \verbatim
myPatch <patchName>
{ {
code code
#{ #{

View File

@ -33,7 +33,6 @@ Description
and radial velocity. and radial velocity.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
axis | axis of rotation | yes | axis | axis of rotation | yes |
@ -45,7 +44,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type cylindricalInletVelocity; type cylindricalInletVelocity;
axis (0 0 1); axis (0 0 1);

View File

@ -84,7 +84,6 @@ Description
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
commsDir | communications directory | yes | commsDir | communications directory | yes |
@ -98,7 +97,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type externalCoupled; type externalCoupled;
commsDir "$FOAM_CASE/comms"; commsDir "$FOAM_CASE/comms";

View File

@ -35,7 +35,6 @@ Description
contant, polynomial, table values. contant, polynomial, table values.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
patchType | underlying patch type should be \c cyclic| yes | patchType | underlying patch type should be \c cyclic| yes |
@ -46,7 +45,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fan; type fan;
patchType cyclic; patchType cyclic;

View File

@ -32,7 +32,6 @@ Description
or outlet total pressure condition for a fan. or outlet total pressure condition for a fan.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
fileName | fan curve file name | yes | fileName | fan curve file name | yes |

View File

@ -34,7 +34,7 @@ Description
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fixedFluxExtrapolatedPressure; type fixedFluxExtrapolatedPressure;
} }

View File

@ -34,7 +34,7 @@ Description
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fixedFluxPressure; type fixedFluxPressure;
} }

View File

@ -33,10 +33,9 @@ Description
behaviour is to act as a zero gradient condition. behaviour is to act as a zero gradient condition.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fixedInternalValue; type fixedInternalValue;
value uniform 0; // place holder value uniform 0; // place holder

View File

@ -35,7 +35,6 @@ Description
'owner' patch. 'owner' patch.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
patchType | underlying patch type should be \c cyclic| yes | patchType | underlying patch type should be \c cyclic| yes |
@ -44,7 +43,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fixedJump; type fixedJump;
patchType cyclic; patchType cyclic;

View File

@ -35,7 +35,6 @@ Description
'owner' patch. 'owner' patch.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
patchType | underlying patch type should be \c cyclic| yes | patchType | underlying patch type should be \c cyclic| yes |
@ -44,7 +43,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fixedJumpAMI; type fixedJumpAMI;
patchType cyclic; patchType cyclic;

View File

@ -33,7 +33,6 @@ Description
time-varying, mean value. time-varying, mean value.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
meanValue | mean value Function1 | yes | meanValue | mean value Function1 | yes |
@ -41,7 +40,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fixedMean; type fixedMean;
meanValue 1.0; meanValue 1.0;

View File

@ -42,7 +42,6 @@ Description
apply zero-gradient condition to tangential components. apply zero-gradient condition to tangential components.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
phi | flux field name | no | phi phi | flux field name | no | phi
@ -52,7 +51,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fixedNormalInletOutletVelocity; type fixedNormalInletOutletVelocity;

View File

@ -31,7 +31,6 @@ Description
This boundary condition sets the patch-normal component to a fixed value. This boundary condition sets the patch-normal component to a fixed value.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
fixedValue | fixed value | yes | fixedValue | fixed value | yes |
@ -39,7 +38,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fixedNormalSlip; type fixedNormalSlip;
fixedValue uniform 0; // example entry for a scalar field fixedValue uniform 0; // example entry for a scalar field

View File

@ -49,7 +49,6 @@ Description
\c thermodynamicProperties dictionary. \c thermodynamicProperties dictionary.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
p | pressure field name | no | p p | pressure field name | no | p
@ -57,7 +56,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fixedPressureCompressibleDensity; type fixedPressureCompressibleDensity;
p p; p p;

View File

@ -31,7 +31,6 @@ Description
This boundary condition provides a fixed value profile condition. This boundary condition provides a fixed value profile condition.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
profile | Profile Function1 | yes | profile | Profile Function1 | yes |
@ -41,7 +40,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fixedProfile; type fixedProfile;
profile csvFile; profile csvFile;

View File

@ -53,7 +53,7 @@ Usage
Example of the boundary condition specification for a volumetric flow rate: Example of the boundary condition specification for a volumetric flow rate:
\verbatim \verbatim
myPatch <patchName>
{ {
type flowRateInletVelocity; type flowRateInletVelocity;
volumetricFlowRate 0.2; volumetricFlowRate 0.2;
@ -64,7 +64,7 @@ Usage
Example of the boundary condition specification for a mass flow rate: Example of the boundary condition specification for a mass flow rate:
\verbatim \verbatim
myPatch <patchName>
{ {
type flowRateInletVelocity; type flowRateInletVelocity;
massFlowRate 0.2; massFlowRate 0.2;

View File

@ -56,7 +56,7 @@ Description
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type fluxCorrectedVelocity; type fluxCorrectedVelocity;
phi phi; phi phi;

View File

@ -34,7 +34,6 @@ Description
based on the sign of the flux. based on the sign of the flux.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
freestreamValue | freestream velocity | yes | freestreamValue | freestream velocity | yes |
@ -43,7 +42,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type freestream; type freestream;
phi phi; phi phi;

View File

@ -33,7 +33,6 @@ Description
based on the free-stream velocity. based on the free-stream velocity.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
U | velocity field name | no | U U | velocity field name | no | U
@ -43,7 +42,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type freestreamPressure; type freestreamPressure;
} }

View File

@ -32,7 +32,6 @@ Description
specified inflow for the case of return flow. specified inflow for the case of return flow.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
phi | Flux field name | no | phi phi | Flux field name | no | phi
@ -41,7 +40,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type inletOutlet; type inletOutlet;
phi phi; phi phi;

View File

@ -33,7 +33,6 @@ Description
value is applied in the case of reverse flow. value is applied in the case of reverse flow.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
U | velocity field name | no | U U | velocity field name | no | U
@ -46,7 +45,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type inletOutletTotalTemperature; type inletOutletTotalTemperature;
U U; U U;

View File

@ -33,7 +33,6 @@ Description
thr data locally. thr data locally.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
fieldName | name of field to be mapped | no | this field name fieldName | name of field to be mapped | no | this field name
@ -43,7 +42,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type mappedField; type mappedField;
fieldName T; // optional field name fieldName T; // optional field name

View File

@ -32,7 +32,6 @@ Description
neighbour patch field to the boundary and internal values of *this. neighbour patch field to the boundary and internal values of *this.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
fieldName | name of field to be mapped | no | this field name fieldName | name of field to be mapped | no | this field name
@ -41,7 +40,7 @@ Usage
\endtable \endtable
\verbatim \verbatim
myPatch <patchName>
{ {
type mappedFixedInternalValue; type mappedFixedInternalValue;
fieldName T; fieldName T;

View File

@ -32,7 +32,6 @@ Description
field to the boundary and internal cell values of *this. field to the boundary and internal cell values of *this.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
fieldName | name of field to be mapped | no | this field name fieldName | name of field to be mapped | no | this field name
@ -42,7 +41,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type mappedFixedPushedInternalValue; type mappedFixedPushedInternalValue;
fieldName T; fieldName T;

View File

@ -35,7 +35,6 @@ Description
mappedPatchBase class. mappedPatchBase class.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
fieldName | name of field to be mapped | no | this field name fieldName | name of field to be mapped | no | this field name
@ -46,7 +45,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type mapped; type mapped;
fieldName T; fieldName T;

View File

@ -38,7 +38,6 @@ Description
velocity when applying the mass basis. velocity when applying the mass basis.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
phi | flux field name | no | phi phi | flux field name | no | phi
@ -48,7 +47,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type mappedFlowRate; type mappedFlowRate;
phi phi; phi phi;

View File

@ -32,7 +32,6 @@ Description
to this patch to this patch
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
phi | flux field name | no | phi phi | flux field name | no | phi
@ -40,7 +39,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type mappedVelocityFlux; type mappedVelocityFlux;
phi phi; phi phi;

View File

@ -33,10 +33,9 @@ Description
for moving reference frame (MRF) calculations. for moving reference frame (MRF) calculations.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type movingWallVelocity; type movingWallVelocity;
value uniform (0 0 0); // Initial value value uniform (0 0 0); // Initial value

View File

@ -31,10 +31,9 @@ Description
This boundary condition fixes the velocity to zero at walls. This boundary condition fixes the velocity to zero at walls.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type noSlip; type noSlip;
} }

View File

@ -32,7 +32,6 @@ Description
specified outflow for the case of reverse flow. specified outflow for the case of reverse flow.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
phi | Flux field name | no | phi phi | Flux field name | no | phi
@ -41,7 +40,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type outletInlet; type outletInlet;
phi phi; phi phi;

View File

@ -33,7 +33,6 @@ Description
field over this patch. field over this patch.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
outletPatchName | name of outlet patch | yes | outletPatchName | name of outlet patch | yes |
@ -42,7 +41,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type outletMappedUniformInlet; type outletMappedUniformInlet;
outletPatchName aPatch; outletPatchName aPatch;

View File

@ -44,7 +44,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type outletPhaseMeanVelocity; type outletPhaseMeanVelocity;
Umean 1.2; Umean 1.2;

View File

@ -32,7 +32,6 @@ Description
slip is controlled by a user-supplied field. slip is controlled by a user-supplied field.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
valueFraction | fraction od value used for boundary [0-1] | yes | valueFraction | fraction od value used for boundary [0-1] | yes |
@ -40,7 +39,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type partialSlip; type partialSlip;
valueFraction uniform 0.1; valueFraction uniform 0.1;

View File

@ -49,7 +49,6 @@ Description
- 0: apply a zero-gradient condition - 0: apply a zero-gradient condition
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
phaseFraction | phase-fraction field name | no | alpha phaseFraction | phase-fraction field name | no | alpha
@ -60,7 +59,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type phaseHydrostaticPressure; type phaseHydrostaticPressure;
phaseFraction alpha1; phaseFraction alpha1;

View File

@ -64,7 +64,6 @@ Description
\endverbatim \endverbatim
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
gamma | ratio of specific heats | yes | none gamma | ratio of specific heats | yes | none
@ -84,7 +83,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type plenumPressure; type plenumPressure;
gamma 1.4; gamma 1.4;

View File

@ -34,7 +34,6 @@ Description
is obtained from the flux with the specified inlet direction. is obtained from the flux with the specified inlet direction.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
phi | flux field name | no | phi phi | flux field name | no | phi
@ -44,7 +43,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type pressureDirectedInletOutletVelocity; type pressureDirectedInletOutletVelocity;
phi phi; phi phi;

View File

@ -33,7 +33,6 @@ Description
the specified inlet direction" direction. the specified inlet direction" direction.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
phi | flux field name | no | phi phi | flux field name | no | phi
@ -43,7 +42,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type pressureDirectedInletVelocity; type pressureDirectedInletVelocity;
phi phi; phi phi;

View File

@ -36,7 +36,6 @@ Description
A slip condition is applied tangential to the patch. A slip condition is applied tangential to the patch.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
phi | flux field name | no | phi phi | flux field name | no | phi
@ -45,7 +44,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type pressureInletOutletParSlipVelocity; type pressureInletOutletParSlipVelocity;
value uniform 0; value uniform 0;

View File

@ -36,7 +36,6 @@ Description
The tangential patch velocity can be optionally specified. The tangential patch velocity can be optionally specified.
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
phi | flux field name | no | phi phi | flux field name | no | phi
@ -45,7 +44,7 @@ Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type pressureInletOutletVelocity; type pressureInletOutletVelocity;
phi phi; phi phi;

View File

@ -34,10 +34,9 @@ Description
normal to the patch faces. normal to the patch faces.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type pressureInletUniformVelocity; type pressureInletUniformVelocity;
value uniform 0; value uniform 0;

View File

@ -33,10 +33,9 @@ Description
a direction normal to the patch faces. a direction normal to the patch faces.
Usage Usage
Example of the boundary condition specification: Example of the boundary condition specification:
\verbatim \verbatim
myPatch <patchName>
{ {
type pressureInletVelocity; type pressureInletVelocity;
phi phi; phi phi;

Some files were not shown because too many files have changed in this diff Show More