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

STYLE: Refactored doxygen tags

Browse Source
This commit is contained in:
andy
2012-07-19 16:09:31 +01:00
parent 78c03fb65b
commit 30619cbf58
123 changed files with 375 additions and 373 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -37,16 +37,16 @@ Description
\f]
where
/vartable
\vartable
U_p = patch velocity [m/s]
U_{Inf} = free stream velocity in the absolute frame [m/s]
theta = swept angle [rad]
n = axis direction of the SRF
U_{p,srf} = SRF velocity of the patch
/endvartable
\endvartable
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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

@ -50,7 +50,7 @@ Description
Up = U_in - U_srf
\f]
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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

@ -32,7 +32,7 @@ Description
that the value is assigned via field assignment, and not via a call to
e.g. \c updateCoeffs or \c evaluate.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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

@ -36,19 +36,19 @@ Description
\f]
where
/vartable
\vartable
x_p | patch values
x_c | internal field values
\nabla(x)| gradient (user-specified)
\Delta | inverse distance from patch face centre to cell centre
/endvartable
\endvartable
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
gradient | gradient | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -31,12 +31,12 @@ Description
This boundary condition supplies a fixed value constraint, and is the base
class for a number of other boundary conditions.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
value | values | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -39,14 +39,14 @@ Description
\f]
where
/vartable
\vartable
x_p | patch values
x_c | patch internal cell values
w | weight field, \c valueFraction_
A | fixed value, \c refValue_
B | patch normal gradient, \c refGrad_
\Delta| inverse distance from face centre to internal cell centre
/endvartable
\endvartable
\note
This condition is not usually applied directly; instead, use a derived

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

@ -31,7 +31,7 @@ Description
This boundary condition appies a zero-gradient condition from the patch
internal field onto the patch faces.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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

@ -36,7 +36,7 @@ Description
transformed to the neighbour patch, the patches should be identical (or
very similar).
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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

@ -37,7 +37,7 @@ Description
patch is transformed to the neighbour patch, the outer perimiter of each
patch should be identical (or very similar).
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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

@ -31,7 +31,7 @@ Description
This boundary condition is a light wrapper around the cyclicFvPatchField
condition, providing no new functionality.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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

@ -33,7 +33,7 @@ Description
patches whose normal is aligned to geometric directions that do not
constitue solution directions.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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

@ -30,7 +30,7 @@ Group
Description
This boundary condition enables processor communication across patches.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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

@ -31,7 +31,7 @@ Description
This boundary condition enables processor communication across cyclic
patches.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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

@ -30,7 +30,7 @@ Group
Description
This boundary condition enforces a symmetry constraint
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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

@ -31,7 +31,7 @@ Description
This boundary condition is similar to the cyclic condition, except that
it is applied to 2-D geometries.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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

@ -44,19 +44,19 @@ Description
where
/vartable
\vartable
x | baffle open fraction [0-1]
x_{old} | baffle open fraction on previous evaluation
dt | simulation time step
DT | time taken to open the baffle
F_{net} | net force across the baffle
/endvartable
\endvartable
The open fraction is then applied to scale the patch areas.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
p | pressure field name | no | p
cyclicPatch | cylclic patch name | yes |
@ -64,7 +64,7 @@ Description
openFraction | current opatch open fraction [0-1]| yes |
openingTime | time taken to open the baffle | yes |
maxOpenFractionDelta | max open fraction change per timestep | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -44,18 +44,18 @@ Description
where
/vartable
\vartable
x | baffle open fraction [0-1]
x_{old} | baffle open fraction on previous evaluation
dt | simulation time step
DT | time taken to open the baffle
/endvartable
\endvartable
The open fraction is then applied to scale the patch areas.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
p | pressure field name | no | p
cyclicPatch | cylclic patch name | yes |
@ -65,7 +65,7 @@ Description
maxOpenFractionDelta | max open fraction change per timestep | yes |
minThresholdValue | minimum open fraction for activation | yes |
forceBased | force (true) or pressure-based (false) activation | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -48,15 +48,15 @@ Description
the flow-speed plus the acoustic wave speed creating an acoustic wave
transmissive boundary condition.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
rho | density field name | no | rho
fieldInf | value of field beyond patch | no |
lInf | distance beyond patch for \c fieldInf | no |
/endtable
\endtable
\note
If \c lInf is specified, \c fieldInf will be required; \c rho is only

14
src/finiteVolume/fields/fvPatchFields/derived/buoyantPressure/buoyantPressureFvPatchScalarField.H
View File

@ -43,11 +43,11 @@ Description
where
/vartable
\vartable
\rho | density [kg/m3]
g | acceleration due to gravity [m/s2]
h | patch face centres [m]
/endvartable
\endvartable
Otherwise we assume that it is the static pressure, and the gradient
calculated using:
@ -56,16 +56,16 @@ Description
\f]
where
/vartable
\vartable
n | patch face normal vectors
/endvartable
\endvartable
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
rho | density field name | no | rho
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -31,7 +31,7 @@ Description
Constructs on-the-fly a new boundary condition (derived from
fixedValueFvPatchField) which is then used to evaluate.
/heading Patch usage
\heading Patch usage
Example:
\verbatim

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

@ -31,7 +31,7 @@ Description
Constructs on-the-fly a new boundary condition (derived from
mixedFvPatchField) which is then used to evaluate.
/heading Patch usage
\heading Patch usage
Example:
\verbatim

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

@ -32,16 +32,16 @@ Description
cylindrical co-ordinates given a central axis, central point, rpm, axial
and radial velocity.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
axis | axis of rotation | yes |
centre | centre of rotation | yes |
axialVelocity | axial velocity profile [m/s] | yes |
radialVelocity | radial velocity profile [m/s] | yes |
rpm | rotational speed (revolutions per minute) | yes|
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -34,14 +34,14 @@ Description
The jump is specified as a \c DataEntry type, to enable the use of, e.g.
contant, polynomial, table values.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
patchType | underlying patch type should be \c cyclic| yes |
jump | current jump value | yes |
jumpTable | jump data, e.g. \c csvFile | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -41,21 +41,21 @@ Description
where
/vartable
\vartable
phi | flux
D_p | pressure diffusivity
Sf | patch face areas [m2]
/endvartable
\endvartable
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phiHbyA | name of predicted flux field | no | phiHbyA
phi | name of flux field | no | phi
rho | name of density field | no | rho
Dp | name of pressure diffusivity field | no | Dp
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -32,7 +32,7 @@ Description
directly into a matrix, i.e. to set a constraint condition. Default
behaviour is to act as a zero gradient condition.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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

@ -31,12 +31,12 @@ Description
This boundary condition extrapolates field to the patch using the near-cell
values and adjusts the distribution to match the specified mean value.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
meanValue | mean value | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -30,12 +30,12 @@ Group
Description
This boundary condition sets the patch-normal component to a fixed value.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
fixedValue | fixed value | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -37,23 +37,23 @@ Description
where
/vartable
\vartable
\rho | density [kg/m3]
\rho_{l,sat} | saturation liquid density [kg/m3]
\psi_l | liquid compressibility
p | pressure [Pa]
p_{sat} | saturation pressure [Pa]
/endvartable
\endvartable
The variables \c rholSat, \c pSat and \c psil are retrieved from the
\c thermodynamicProperties dictionary.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
p | pressure field name | no | p
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -43,12 +43,12 @@ Description
For a volumetric-based flux:
- the flow rate is in m3/s
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
flowRate | volumetric [m3/s] OR mass flow rate [kg/s] | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -38,21 +38,21 @@ Description
where
/vartable
\vartable
U_p | velocity at the patch [m/s]
U_c | velocity in cells adjacent to the patch [m/s]
n | patch normal vectors
\phi_p | flux at the patch [m3/s or kg/s]
Sf | patch face area vectors [m2]
/endvartable
\endvartable
where
/table
\table
Property | Description | Required | Default value
phi | name of flux field | no | phi
rho | name of density field | no | rho
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -33,12 +33,12 @@ Description
operation switches between fixed (free stream) value and zero gradient
based on the sign of the flux.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -32,7 +32,7 @@ Description
It is a zero-gradient condition that constrains the flux across the patch
based on the free-stream velocity.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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

@ -31,13 +31,13 @@ Description
This boundary condition provides a generic outflow condition, with
specified inflow for the case of return flow.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
inletValue | inlet value for reverse flow | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -32,9 +32,9 @@ Description
temperature for use with supersonic cases, where a user-specified
value is applied in the case of reverse flow.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
U | velocity field name | no | U
phi | flux field name | no | phi
@ -42,7 +42,7 @@ Description
gamma | heat capacity ration (Cp/Cv) | yes |
inletValue | reverse flow (inlet) value | yes |
T0 | static temperature [K] | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -32,14 +32,14 @@ Description
condition. It does not use information on the patch; instead it holds
thr data locally.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
fieldName | name of field to be mapped | no | this field name
setAverage | flag to activate setting of average value | yes |
average | average value to apply if \c setAverage = yes | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -31,14 +31,14 @@ Description
This boundary condition maps the boundary and internal values of a
neighbour patch field to the boundary and internal values of *this.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
fieldName | name of field to be mapped | no | this field name
setAverage | flag to activate setting of average value | yes |
average | average value to apply if \c setAverage = yes | yes |
/endtable
\endtable
\verbatim
myPatch

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

@ -31,14 +31,14 @@ Description
This boundary condition maps the boundary values of a neighbour patch
field to the boundary and internal cell values of *this.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
fieldName | name of field to be mapped | no | this field name
setAverage | flag to activate setting of average value | yes |
average | average value to apply if \c setAverage = yes | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -34,15 +34,15 @@ Description
The sample mode is set by the underlying mapping engine, provided by the
mappedPatchBase class.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
fieldName | name of field to be mapped | no | this field name
setAverage | flag to activate setting of average value | yes |
average | average value to apply if \c setAverage = yes | yes |
interpolationScheme | type of interpolation scheme | no |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -37,14 +37,14 @@ Description
dimensions of the flux, phi. The current density is used to correct the
velocity when applying the mass basis.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
rho | density field name | no | rho
neigPhi | name of flux field on neighbour mesh | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -31,12 +31,12 @@ Description
This boundary condition maps the velocity and flux from a neighbour patch
to this patch
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -33,12 +33,12 @@ Description
for moving reference frame (MRF) calculations.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
U | velociy field name | no | U
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

10
src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H
View File

@ -41,21 +41,21 @@ Description
where
/vartable
\vartable
\phi | flux
Dp | pressure diffusivity
Sf | patch face areas [m2]
/endvartable
\endvartable
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phiHbyA | name of predicted flux field | no | phiHbyA
phi | name of flux field | no | phi
rho | name of density field | no | rho
Dp | name of pressure diffusivity field | no | Dp
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

10
src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H
View File

@ -37,24 +37,24 @@ Description
where
/vartable
\vartable
x_p | patch values
x_{ref} | patch reference values
x_o | patch offset values
a | amplitude
f | frequency [1/s]
t | time [s]
/endvartable
\endvartable
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
refValue | reference value | yes |
offset | offset value | no | 0.0; // optional
amplitude | oscillation amplitude | yes |
frequency | oscillation frequency | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -31,13 +31,13 @@ Description
This boundary condition provides a generic inflow condition, with
specified outflow for the case of return flow.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
inletValue | inlet value | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -32,13 +32,13 @@ Description
by name "outletPatchName" and applies this as the uniform value of the
field over this patch.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
outletPatchName | name of outlet patch | yes |
phi | flux field name | no | phi
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -31,12 +31,12 @@ Description
This boundary condition provides a partial slip condition. The amount of
slip is controlled by a user-supplied field.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
valueFraction | fraction od value used for boundary [0-1] | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -36,27 +36,27 @@ Description
\f]
where
/vartable
\vartable
p_{hyd} | hyrostatic pressure [Pa]
p_{ref} | reference pressure [Pa]
x_{ref} | reference point in Cartesian co-ordinates
\rho | density (assumed uniform)
g | acceleration due to gravity [m/s2]
/endtable
\endtable
The values are assigned according to the phase-fraction field:
- 1: apply \$fp_{hyd}\$f
- 0: apply a zero-gradient condition
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phaseName | phase field name | no | alpha
rho | density field name | no | rho
pRefValue | reference pressure [Pa] | yes |
pRefPoint | reference pressure location | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -33,14 +33,14 @@ Description
applied for outflow (as defined by the flux); for inflow, the velocity
is obtained from the flux with the specified inlet direction.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
rho | density field name | no | rho
inletDirection | inlet direction per patch face | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -32,14 +32,14 @@ Description
pressure is specified. The inflow velocity is obtained from the flux with
the specified inlet direction" direction.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
rho | density field name | no | rho
inletDirection | inlet direction per patch face | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -35,13 +35,13 @@ Description
A slip condition is applied tangential to the patch.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
rho | density field name | no | rho
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -35,13 +35,13 @@ Description
The tangential patch velocity can be optionally specified.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
tangentialVelocity | tangential velocity field | no |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

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

@ -33,7 +33,7 @@ Description
averaging the flux over the patch, and then applying it in the direction
normal to the patch faces.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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

@ -32,7 +32,7 @@ Description
pressure is specified. The inflow velocity is obtained from the flux with
a direction normal to the patch faces.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

6
src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H
View File

@ -33,13 +33,13 @@ Description
outflow (as defined by the flux); for inflow, the velocity is obtained from
the flux with a direction normal to the patch faces.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
rho | density field name | no | rho
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H
View File

@ -33,14 +33,14 @@ Description
for outflow (as defined by the flux); for inflow, the velocity is obtained
from the flux with a direction normal to the patch faces.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
tangentialVelocity | tangential velocity field | no |
omega | angular velocty of the frame [rad/s] | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H
View File

@ -31,9 +31,9 @@ Description
This boundary condition provides a total pressure condition for patches
in a rotating frame.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
U | velocity field name | no | U
phi | flux field name | no | phi
@ -42,7 +42,7 @@ Description
gamma | ratio of specific heats (Cp/Cv) | yes |
p0 | static pressure reference | yes |
omega | angular velocty of the frame [rad/s] | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H
View File

@ -30,14 +30,14 @@ Group
Description
This boundary condition provides a rotational velocity condition.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
origin | origin of rotation in Cartesian co-ordinates | yes|
axis | axis of rotation | yes |
omega | angular velocty of the frame [rad/s] | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

2
src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H
View File

@ -30,7 +30,7 @@ Group
Description
This boundary condition provides a slip constraint.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

6
src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H
View File

@ -36,15 +36,15 @@ Description
- subsonic outflow is applied via a zero-gradient condition from inside
the domain.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
UInf | free-stream velocity | yes |
pInf | free-stream pressure | yes |
TInf | free-stream temperature | yes |
gamma | heat capacity ratio (cp/Cv) | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H
View File

@ -31,12 +31,12 @@ Description
This boundary condition provides a surface-normal vector boundary condition
by its magnitude.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
refValue | reference value | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H
View File

@ -37,15 +37,15 @@ Description
dimensions of the flux, phi. The current density is used to correct the
velocity when applying the mass basis.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
rho | density field name | no | rho
flowRate | flow rate profile | yes |
rpm | rotational speed profile | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H
View File

@ -37,9 +37,9 @@ Description
pressure and compressibility which is assumed constant, i.e. isothermal
expansion/compression.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
Ap | syringe piston area [m2] | yes |
Sp | syringe piston speed [m/s] | yes |
@ -51,7 +51,7 @@ Description
psI | initial syringe pressure [Pa] | yes |
psi | gas compressibility [m2/s2] | yes |
ams | added (or removed) gas mass [kg] | yes |
/endtable
\endtable
Example of the BC specification:
\verbatim

6
src/finiteVolume/fields/fvPatchFields/derived/temperatureJump/temperatureJumpFvPatchScalarField.H
View File

@ -34,14 +34,14 @@ Description
The jump is specified as a \c DataEntry type, to enable the use of, e.g.
contant, polynomial, table values.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
patchType | underlying patch type should be \c cyclic| yes |
jump | current jump value | yes |
jumpTable | jump data, e.g. \c csvFile | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H
View File

@ -42,14 +42,14 @@ Description
Values are interpolated linearly between times.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
setAverage | flag to activate setting of average value | yes |
perturb | perturb points for regular geometries | no | 1e-5
fieldTableName | alternative field name to sample | no| this field name
/endtable
\endtable
/verbatim
myPatch

26
src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H
View File

@ -36,62 +36,62 @@ Description
p_T = p_0 + 0.5 |U|^2
\f]
where
/vartable
\vartable
p_T | incompressible total pressure [m2/s2]
p_0 | incompressible reference pressure [m2/s2]
U | velocity
/endvartable
\endvartable
2. compressible subsonic:
\f[
p_T = p_0 + 0.5 \rho |U|^2
\f]
where
/vartable
\vartable
p_T | total pressure [Pa]
p_0 | reference pressure [Pa]
\rho | density [kg/m3]
U | velocity
/endvartable
\endvartable
3. compressible transonic (\gamma <= 1):
\f[
p_T = \frac{p_0}{1 + 0.5 \psi |U|^2}
\f]
where
/vartable
\vartable
p_T | total pressure [Pa]
p_0 | reference pressure [Pa]
G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$
/endvartable
\endvartable
4. compressible supersonic (\gamma > 1):
\f[
p_T = \frac{p_0}{(1 + 0.5 \psi G)^{\frac{1}{G}}}
\f]
where
/vartable
\vartable
\gamma | ratio of specific heats (Cp/Cv)
p_T | total pressure [Pa]
p_0 | reference pressure [Pa]
\psi | compressibility [m2/s2]
G | coefficient given by \f$\frac{\gamma}{1-\gamma}\f$
/endvartable
\endvartable
The modes of operation are set via the combination of \c phi, \c rho, and
\c psi entries:
/table
\table
Mode | phi | rho | psi
incompressible subsonic | phi | none | none
compressible subsonic | phi | rho | none
compressible transonic | phi | none | psi
compressible supersonic | phi | none | psi
/endtable
\endtable
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
U | velocity field name | no | U
phi | flux field name | no | phi
@ -99,7 +99,7 @@ Description
psi | compressibility field name | no | none
gamma | ratio of specific heats (Cp/Cv) | yes |
p0 | static pressure reference | yes |
/endtable
\endtable
\note
The default boundary behaviour is for subsonic, incompressible flow.

6
src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H
View File

@ -30,16 +30,16 @@ Group
Description
This boundary condition provides a total temperature condition.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
U | Velocity field name | no | U
phi | Flux field name | no | phi
psi | Compressibility field name | no | psi
gamma | ratio of specific heats (Cp/Cv) | yes |
T0 | reference temperature | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H
View File

@ -31,12 +31,12 @@ Description
This boundary condition provides a velocity condition for translational
motion on walls.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
U | translational velocity | yes|
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

10
src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H
View File

@ -37,23 +37,23 @@ Description
where
/vartable
\vartable
x_p | patch values
x_{ref} | refernce patch values
n | time level
\alpha | fraction of new random component added to previous time value
C_{RMS} | RMS coefficient
s | fluctuation scale
/endvartable
\endvartable
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
fluctuationScale | RMS fluctuation scale (fraction of mean) | yes |
referenceField | reference (mean) field | yes |
alpha | fraction of new random component added to previous| no| 0.1
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

10
src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H
View File

@ -38,22 +38,22 @@ Description
where
/vartable
\vartable
k_p | kinetic energy at the patch
I | turbulence intensity
U | velocity field
/endvartable
\endvartable
In the event of reverse flow, a zero-gradient condition is applied.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
intensity | fraction of mean field [0-1] | yes |
U | velocity field name | no | U
phi | flux field name | no | phi
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

10
src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H
View File

@ -36,22 +36,22 @@ Description
\f]
where
/vartable
\vartable
p_{hyd} | hyrostatic pressure [Pa]
p_{ref} | reference pressure [Pa]
x_{ref} | reference point in Cartesian co-ordinates
\rho | density (assumed uniform)
g | acceleration due to gravity [m/s2]
/endtable
\endtable
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
rho | uniform density [kg/m3] | yes |
pRefValue | reference pressure [Pa] | yes |
pRefPoint | reference pressure location | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H
View File

@ -30,12 +30,12 @@ Group
Description
This boundary condition provides a uniform fixed value condition.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
uniformValue | uniform value | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H
View File

@ -31,9 +31,9 @@ Description
This boundary condition provides a time-varying form of the uniform total
pressure boundary condition.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
U | velocity field name | no | U
phi | flux field name | no | phi
@ -42,7 +42,7 @@ Description
gamma | ratio of specific heats (Cp/Cv) | yes |
p0 | static pressure reference | yes |
pressure | total pressure as a function of time | yes |
/endtable
\endtable
\note
The default boundary behaviour is for subsonic, incompressible flow.

6
src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H
View File

@ -41,14 +41,14 @@ Description
if alpha < lowerBound:
- apply a fixed value condition, with a uniform level of the lower bound
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
lowerBound | lower bound for clipping | yes |
upperBound | upper bound for clipping | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H
View File

@ -34,12 +34,12 @@ Description
The flow rate is made proportional to the phase fraction alpha at each
face of the patch and alpha is ensured to be bound between 0 and 1.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
flowRate | volumetric flow rate [m3/s] | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

10
src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H
View File

@ -35,23 +35,23 @@ Description
p = -\rho*g*\zeta
\f]
/vartable
\vartable
\rho | density [kg/m3]
g | acceleration due to gravity [m/s2]
\zeta | wave amplitude [m]
/endvartable
\endvartable
The wave amplitude is updated as part of the calculation, derived from the
local volumetric flux.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
rho | density field name | no | rho
zeta | wave amplitude field name | no | zeta
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

10
src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H
View File

@ -39,23 +39,23 @@ Description
where
/vartable
\vartable
x_p | patch values
\phi_p | patch face flux
\psi_p | patch compressibility
Sf | patch face area vector
\gamma | ratio of specific heats
/endvartable
\endvartable
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | flux field name | no | phi
rho | density field name | no | rho
psi | compressibility field name | no | psi
gamma | ratio of specific heats (Cp/Cv) | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

12
src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox
View File

@ -58,31 +58,31 @@ Wall functions for compressible flow
\section secBoundaryConditions Typical usage for pressure-velocity systems
subsonic inlet (flow specified):
/table
\table
Variable | Symbol | Type
pressure | p | \link Foam::zeroGradientFvPatchField zeroGradient\endlink
velocity | U | \link Foam::fixedValueFvPatchField fixedValue\endlink
transported property | - | \link Foam::fixedValueFvPatchField fixedValue\endlink
derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink
/endtable
\endtable
subsonic outlet:
/table
\table
Variable | Symbol | Type
pressure | p | \link Foam::fixedValueFvPatchField fixedValue\endlink
velocity | U | \link Foam::inletOutletFvPatchField inletOutlet\endlink or \link Foam::pressureInletOutletVelocityFvPatchVectorField pressureInletOutletVelocity\endlink
transported property | - | \link Foam::inletOutletFvPatchField inletOutlet\endlink
derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink
/endtable
\endtable
wall:
/table
\table
Variable | Symbol | Type
pressure | p | \link Foam::zeroGradientFvPatchField zeroGradient\endlink
velocity | U | \link Foam::fixedValueFvPatchField fixedValue\endlink
transported property | - | \link Foam::fixedValueFvPatchField fixedValue\endlink
derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink
/endtable
\endtable
\*---------------------------------------------------------------------------*/

10
src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H
View File

@ -38,23 +38,23 @@ Description
\f]
where
/vartable
\vartable
U_p | patch velocity [m/s]
n | patch normal vector
\phi | mass flux [kg/s]
\rho | density [kg/m3]
Sf | patch face area vectors [m2]
\delta | film height [m]
/endvartable
\endvartable
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
phi | Flux field name | no | phi
rho | density field name | no | rho
deltaf | height field name | no | deltaf
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H
View File

@ -33,16 +33,16 @@ Description
condition varies from the standard wall function by taking into account any
mass released from the film model.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
B | model coefficient | no | 5.5
yPlusCrit | critical y+ for transition to turbulent flow | no|11.05
Cmu | model coefficient | no | 0.09
kappa | Von-Karman constant | no | 0.41
Prt | turbulent Prandtl number | no | 0.85
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

2
src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H
View File

@ -32,7 +32,7 @@ Description
using wall functions, based on turbulence kinetic energy, for use with
surface film models.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

6
src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpFvPatchScalarField.H
View File

@ -31,12 +31,12 @@ Description
This boundary condition provides an energy jump condition across a pair
of coupled patches.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
jump | energy jump values | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

2
src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H
View File

@ -30,7 +30,7 @@ Group
Description
This boundary condition provides a fixed condition for internal energy
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

2
src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H
View File

@ -30,7 +30,7 @@ Group
Description
This boundary condition provides a gradient condition for internal energy
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch

6
src/thermophysicalModels/basic/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H
View File

@ -31,13 +31,13 @@ Description
This boundary condition provides an enthalpy condition for wall heat
transfer
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
Tinf | wall temperature | yes |
alphaWall | thermal diffusivity | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H
View File

@ -34,12 +34,12 @@ Description
The radiation temperature is retrieved from the mesh database, using a
user specified temperature field name.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
T | temperature field name | no | T
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/thermophysicalModels/radiationModels/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H
View File

@ -34,12 +34,12 @@ Description
The radiation temperature field across the patch is supplied by the user
using the \c Trad entry.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
T | temperature field name | no | T
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H
View File

@ -33,13 +33,13 @@ Description
(fvDOM), in which the radiation temperature is retrieved from the
temperature field boundary condition.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
T | temperature field name | no | T
emissivityMode | emissivity mode: solidThermo or lookup | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H
View File

@ -31,13 +31,13 @@ Description
This boundary condition provides a grey-diffuse condition for radiative
heat flux, \c Qr, for use with the view factor model
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
Qro | external radiative heat flux | yes |
emissivityMode | emissivity mode: solidThermo or lookup | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

2
src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H
View File

@ -31,7 +31,7 @@ Description
This boundary condition provides a wide-band, diffusive radiation
condition, where the patch temperature is specified.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

10
src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H
View File

@ -42,20 +42,20 @@ Description
where
/vartable
\vartable
htc_p | patch convective heat transfer coefficient
Re | Reynolds number
Pr | Prandtl number
\kappa_p | thermal conductivity
L | length scale
/endvartable
\endvartable
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
L | Length scale [m] | yes |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

10
src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H
View File

@ -39,24 +39,24 @@ Description
where
/vartable
\vartable
\epsilon_p | patch epsilon values
C_{\mu} | Model coefficient, set to 0.09
k | turbulence kinetic energy
L | length scale
/endvartable
\endvartable
\note
In the event of reverse flow, a zero-gradient condition is applied
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
mixingLength | Length scale [m] | yes |
phi | flux field name | no | phi
k | turbulence kinetic energy field name | no | k
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

10
src/turbulenceModels/compressible/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H
View File

@ -38,24 +38,24 @@ Description
where
/vartable
\vartable
\omega_p | patch omega values
C_{\mu} | Model coefficient, set to 0.09
k | turbulence kinetic energy
L | length scale
/endvartable
\endvartable
\note
In the event of reverse flow, a zero-gradient condition is applied
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
mixingLength | Length scale [m] | yes |
phi | flux field name | no | phi
k | turbulence kinetic energy field name | no | k
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

6
src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H
View File

@ -31,15 +31,15 @@ Description
This boundary condition provides a thermal wall function for turbulent
thermal diffusivity (usually\c alphat) based on the Jayatilleke model.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
Prt | turbulent Prandtl number | no | 0.85
Cmu | model coefficient | no | 0.09
kappa | Von Karman constant | no | 0.41
E | model coefficient | no | 9.8
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

10
src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H
View File

@ -40,19 +40,19 @@ Description
where
/vartable
\vartable
\alpha_t| turblence thermal diffusivity
\mu_t | turblence viscosity
Pr_t | turblent Prandtl number
/endvartable
\endvartable
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
mut | turbulence viscosity field name | no | mut
Prt | turbulent Prandtl number | no | 0.85
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

10
src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H
View File

@ -38,20 +38,20 @@ Description
where
/vartable
\vartable
epsilon | turblence dissipation field
G | turblence generation field
/endvartable
\endvartable
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
G | turbulence generation field name | no | G
Cmu | model coefficient | no | 0.09
kappa | Von Karman constant | no | 0.41
E | model coefficient | no | 9.8
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

2
src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H
View File

@ -31,7 +31,7 @@ Description
This boundary condition is applied to turbulence \c k, \c q, and \c R
when using wall functions, and simply enforces a zero-gradient condition.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

2
src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutLowReWallFunction/mutLowReWallFunctionFvPatchScalarField.H
View File

@ -32,7 +32,7 @@ Description
with low Reynolds number models. It sets \c nut to zero, and provides an
access function to calculate y+.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

6
src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H
View File

@ -31,14 +31,14 @@ Description
This boundary condition provides a turbulent viscosity condition when
using wall functions for rough walls, based on velocity.
/heading Patch usage
\heading Patch usage
/table
\table
Property | Description | Required | Default value
roughnessHeight | roughness height | yes |
roughnessConstant | roughness constanr | yes |
roughnessFactor | scaling factor |
/endtable
\endtable
Example of the boundary condition specification:
\verbatim

2
src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H
View File

@ -32,7 +32,7 @@ Description
using wall functions for rough walls, based on velocity, using Spaldings
law to give a continuous nut profile to the wall (y+ = 0)
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

2
src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUWallFunction/mutUWallFunctionFvPatchScalarField.H
View File

@ -31,7 +31,7 @@ Description
This boundary condition provides a turbulent viscosity condition when
using wall functions, based on velocity.
/heading Patch usage
\heading Patch usage
Example of the boundary condition specification:
\verbatim

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