zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated header documentation processed by Doxygen

Browse Source
This commit is contained in:
Henry Weller
2016-06-19 21:23:54 +01:00
parent 0c62c8e1d0
commit 71fdcab771
162 changed files with 214 additions and 361 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
applications/solvers/compressible/rhoCentralFoam/BCs/rho/fixedRhoFvPatchScalarField.H
View File

@ -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;
}

3
applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H
View File

@ -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;

2
doc/codingStyleGuide.org
View File

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

3
etc/codeTemplates/BC/BC.H
View File

@ -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;

16
src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
View File

@ -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

3
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H
View File

@ -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;

3
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H
View File

@ -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";

3
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H
View File

@ -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;

23
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/thermalBaffle1D/thermalBaffle1DFvPatchScalarField.H
View File

@ -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_;

1
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H
View File

@ -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 |

3
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H
View File

@ -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;

3
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H
View File

@ -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;

3
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H
View File

@ -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;

3
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H
View File

@ -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;

3
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H
View File

@ -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;

3
src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H
View File

@ -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;
}

1
src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H
View File

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

3
src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H
View File

@ -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;

3
src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H
View File

@ -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;

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H
View File

@ -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;

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H
View File

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

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H
View File

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

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/fWallFunctions/fWallFunction/fWallFunctionFvPatchScalarField.H
View File

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

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H
View File

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

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H
View File

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

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H
View File

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

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H
View File

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

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H
View File

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

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H
View File

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

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H
View File

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

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H
View File

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

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H
View File

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

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H
View File

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

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H
View File

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

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H
View File

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

3
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/v2WallFunctions/v2WallFunction/v2WallFunctionFvPatchScalarField.H
View File

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

3
src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H
View File

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

3
src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H
View File

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

3
src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFWallVelocityFvPatchVectorField/SRFWallVelocityFvPatchVectorField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/basic/extrapolatedCalculated/extrapolatedCalculatedFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H
View File

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

1
src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/constraint/cyclicACMI/cyclicACMIFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/constraint/symmetryPlane/symmetryPlaneFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H
View File

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

5
src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H
View File

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

5
src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H
View File

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

1
src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H
View File

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

2
src/finiteVolume/fields/fvPatchFields/derived/fixedFluxExtrapolatedPressure/fixedFluxExtrapolatedPressureFvPatchScalarField.H
View File

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

2
src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/fixedNormalInletOutletVelocity/fixedNormalInletOutletVelocityFvPatchVectorField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H
View File

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

4
src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H
View File

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

2
src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/noSlip/noSlipFvPatchVectorField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H
View File

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

2
src/finiteVolume/fields/fvPatchFields/derived/outletPhaseMeanVelocity/outletPhaseMeanVelocityFvPatchVectorField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/plenumPressure/plenumPressureFvPatchScalarField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H
View File

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

3
src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H
View File

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

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