zhyang-dev/OpenFOAM-5.x
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doxygen documentation: Use the standard 'Usage' rather than the '\heading....'

Browse Source
This commit is contained in:
Henry Weller
2016-06-17 17:22:24 +01:00
parent 2b7ee7354c
commit 2ca0a6f362
179 changed files with 234 additions and 239 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -44,7 +44,7 @@ Description
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2015-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -33,7 +33,7 @@ Description
thermal diffusivity (usually\c alphat) based on the Jayatilleke model for
the Eulerian multiphase solvers.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

2
applications/utilities/postProcessing/dataConversion/foamToVTK/foamToVTK/writeVTK/writeVTK.H
View File

@ -46,7 +46,7 @@ Description
}
\endverbatim
\heading Function object usage
Usage
\table
Property | Description | Required | Default value
type | type name: writeVTK | yes |

3
applications/utilities/postProcessing/noise/noise.C
View File

@ -32,8 +32,7 @@ Description
or user-specified dictionary using the -dict option. Pressure data is
read using a CSV reader:
\heading Usage
Usage
\verbatim
pRef 101325;
N 65536;

7
bin/tools/doxyFilter.sed
View File

@ -164,6 +164,7 @@ s? *\([a-zA-Z0-9]*\.[a-zA-Z]*\)? <li><a href="%dirName%/\1">\1</a></li>?
s?^$?</ul>?
}
/fileName%<\/a><\/li>$/{
N
s?\n$?</ul>?g
@ -171,12 +172,8 @@ s/<\/li>\n/<\/li> /
s? *\([a-zA-Z0-9]*\.[a-zA-Z]*\)? <li><a href="%dirName%/\1">\1</a></li>?
}
s/.*\*\//\*\//
# Convert /heading in source files to bold font and add some space
s#\\heading \(.*\)#<br><b>\1</b>#g
}
#------------------------------------------------------------------------------

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

@ -43,7 +43,7 @@ Description
Q_{t} | TYPE function of time [units]
\endtable
\heading Patch usage
Usage
\table
Property | Description | Req'd? | Default

2
etc/codeTemplates/functionObject/FUNCTIONOBJECT.H
View File

@ -42,7 +42,7 @@ Description
}
\endverbatim
\heading Function object usage
Usage
\table
Property | Description | Required | Default value
type | type name: FUNCTIONOBJECT | yes |

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -50,7 +50,7 @@ Description
L | length scale
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -83,7 +83,7 @@ Description
read the return values, and pass program execution back to OpenFOAM.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -48,7 +48,7 @@ Description
mesh database using the \c lookup option, or from a \c solidThermo
thermophysical package.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

8
src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.H
View File

@ -37,15 +37,15 @@ Description
transformed kappa vector. Field name definable in 'alphaAni',
named 'Anialpha' in solid solver by default
\heading Keywords provided by this class
\table
\par Keywords provided by this class:
\table
Property | Description | Required | Default value
kappaMethod | Thermal conductivity method | yes |
kappa | Name of thermal conductivity field | no | none
alphaAni | Name of the non-isotropic alpha | no | Anialpha
\endtable
\endtable
Usage examples:
Usage
\verbatim
nonIsotropicWall
{

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

@ -36,7 +36,7 @@ Description
Baffle and solid properties need to be specified on the master side
of the baffle.
\heading Patch usage
Usage
Example of the boundary condition specification using constant
solid thermo :

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

@ -29,7 +29,7 @@ Description
heat source either specified in terms of an absolute power [W], or as a
flux [W/m^2].
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -42,7 +42,7 @@ Description
where KDelta is heat-transfer coefficient K * deltaCoeffs
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -35,7 +35,7 @@ Description
mesh database using the \c lookup option, or from a \c solidThermo
or \c fluidThermo thermophysical package.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -31,7 +31,7 @@ Description
This boundary condition provides a thermal wall function for turbulent
thermal diffusivity (usually\c alphat) based on the Jayatilleke model.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -46,7 +46,7 @@ Description
Pr_t | turblent Prandtl number
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -31,7 +31,7 @@ Description
This boundary condition provides an enthalpy condition for wall heat
transfer
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -31,7 +31,7 @@ Description
This boundary condition provides a kinematic turbulent thermal conductivity
for using wall functions, using the Jayatilleke 'P' function.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2014-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2014-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -74,7 +74,7 @@ Description
layer", Journal of Wind Engineering and Industrial Aerodynamics
95(2007), pp 355-369.
\heading Patch usage
Usage
\table
Property | Description | Required | Default

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -45,7 +45,7 @@ Description
L | length scale
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -45,7 +45,7 @@ Description
L | length scale
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -49,7 +49,7 @@ Description
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -38,7 +38,7 @@ Description
The model operates in two modes, based on the computed laminar-to-turbulent
switch-over y+ value derived from kappa and E.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -43,7 +43,7 @@ Description
G | turblence generation field
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -34,7 +34,7 @@ Description
The model operates in two modes, based on the computed laminar-to-turbulent
switch-over y+ value derived from kappa and E.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -34,7 +34,7 @@ Description
The model operates in two modes, based on the computed laminar-to-turbulent
switch-over y+ value derived from kappa and E.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -34,7 +34,7 @@ Description
It is a simple wrapper around the zero-gradient condition.
\heading Patch usage
Usage
Example of the boundary condition specification:
\verbatim

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -32,7 +32,7 @@ Description
for use with low Reynolds number models. It sets \c nut to zero, and
provides an access function to calculate y+.
\heading Patch usage
Usage
Example of the boundary condition specification:
\verbatim

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -31,7 +31,7 @@ Description
This boundary condition provides a turbulent kinematic viscosity condition
when using wall functions for rough walls, based on velocity.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -45,7 +45,7 @@ Description
\endvartable
\heading Patch usage
Usage
Example of the boundary condition specification:
\verbatim

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -33,7 +33,7 @@ Description
of U+ as a function of near-wall Reynolds number. The table should be
located in the $FOAM_CASE/constant directory.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -31,7 +31,7 @@ Description
This boundary condition provides a turbulent kinematic viscosity condition
when using wall functions, based on velocity.
\heading Patch usage
Usage
Example of the boundary condition specification:
\verbatim

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -32,7 +32,7 @@ Description
when using wall functions, based on turbulence kinetic energy.
- replicates OpenFOAM v1.5 (and earlier) behaviour
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -46,7 +46,7 @@ Description
z | vertical co-ordinate
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -37,7 +37,7 @@ Description
- roughness height = sand-grain roughness (0 for smooth walls)
- roughness constant = 0.5-1.0
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -32,7 +32,7 @@ Description
when using wall functions, based on turbulence kinetic energy.
- replicates OpenFOAM v1.5 (and earlier) behaviour
\heading Patch usage
Usage
Example of the boundary condition specification:
\verbatim

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

@ -50,7 +50,7 @@ Description
Nov. 2001
\endverbatim
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -36,7 +36,7 @@ Description
switch-over y+ value derived from kappa and E.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -46,7 +46,7 @@ Description
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -58,7 +58,7 @@ Description
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -47,7 +47,7 @@ Description
The normal component of \f$ U_p \f$ is removed to ensure 0 wall-flux even
if the wall patch faces are irregular.
\heading Patch usage
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
Usage
Example of the boundary condition specification:
\verbatim

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

@ -33,7 +33,7 @@ Description
assigned. \c snGrad returns the patch gradient evaluated from the current
internal and patch field values rather than returning zero.
\heading Patch usage
Usage
Example of the boundary condition specification:
\verbatim

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

@ -43,7 +43,7 @@ Description
\Delta | inverse distance from patch face centre to cell centre
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -31,7 +31,7 @@ Description
This boundary condition supplies a fixed value constraint, and is the base
class for a number of other boundary conditions.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -48,7 +48,7 @@ Description
\endvartable
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

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

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

@ -31,7 +31,7 @@ Description
This boundary condition enforces a cyclic condition between a pair of
boundaries.
\heading Patch usage
Usage
Example of the boundary condition specification:
\verbatim

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

@ -32,7 +32,7 @@ Description
boundaries, whereby communication between the patches is performed using
an arbitrarily coupled mesh interface (ACMI) interpolation.
\heading Patch usage
Usage
Example of the boundary condition specification:
\verbatim

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

@ -32,7 +32,7 @@ Description
boundaries, whereby communication between the patches is performed using
an arbitrary mesh interface (AMI) interpolation.
\heading Patch usage
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
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
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
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
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
Usage
Example of the boundary condition specification:
\verbatim

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

@ -30,7 +30,7 @@ Group
Description
This boundary condition enforces a symmetryPlane constraint
\heading Patch usage
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
Usage
Example of the boundary condition specification:
\verbatim

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -54,7 +54,7 @@ Description
The open fraction is then applied to scale the patch areas.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -57,7 +57,7 @@ Description
The open fraction is then applied to scale the patch areas.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -48,7 +48,7 @@ Description
the flow-speed plus the acoustic wave speed creating an acoustic wave
transmissive boundary condition.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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
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
Usage
Example:
\verbatim

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

@ -32,7 +32,7 @@ Description
cylindrical co-ordinates given a central axis, central point, rpm, axial
and radial velocity.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -83,7 +83,7 @@ Description
read the return values, and pass program execution back to OpenFOAM.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -34,7 +34,7 @@ Description
The jump is specified as a \c Function1 type, to enable the use of, e.g.
contant, polynomial, table values.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -31,7 +31,7 @@ Description
This boundary condition can be applied to assign either a pressure inlet
or outlet total pressure condition for a fan.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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
Usage
Example of the boundary condition specification:
\verbatim

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

@ -34,7 +34,7 @@ Description
The jump is specified as a fixed value field, applied as an offset to the
'owner' patch.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -34,7 +34,7 @@ Description
The jump is specified as a fixed value field, applied as an offset to the
'owner' patch.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -32,7 +32,7 @@ Description
values and adjusts the distribution to match the specified, optionally
time-varying, mean value.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -41,7 +41,7 @@ Description
- fixTangentialInflow is false
apply zero-gradient condition to tangential components.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -30,7 +30,7 @@ Group
Description
This boundary condition sets the patch-normal component to a fixed value.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -48,7 +48,7 @@ Description
The variables \c rholSat, \c pSat and \c psil are retrieved from the
\c thermodynamicProperties dictionary.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -30,7 +30,7 @@ Group
Description
This boundary condition provides a fixed value profile condition.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -42,7 +42,7 @@ Description
For a volumetric-based flux:
- the flow rate is in m3/s
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -33,7 +33,7 @@ Description
operation switches between fixed (free stream) value and zero gradient
based on the sign of the flux.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -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
Usage
\table
Property | Description | Required | Default value

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

@ -31,7 +31,7 @@ Description
This boundary condition provides a generic outflow condition, with
specified inflow for the case of return flow.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -32,7 +32,7 @@ Description
temperature for use with supersonic cases, where a user-specified
value is applied in the case of reverse flow.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -32,7 +32,7 @@ Description
condition. It does not use information on the patch; instead it holds
thr data locally.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -31,7 +31,7 @@ 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
Usage
\table
Property | Description | Required | Default value

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

@ -31,7 +31,7 @@ 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
Usage
\table
Property | Description | Required | Default value

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

@ -34,7 +34,7 @@ Description
The sample mode is set by the underlying mapping engine, provided by the
mappedPatchBase class.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -37,7 +37,7 @@ Description
dimensions of the flux, phi. The current density is used to correct the
velocity when applying the mass basis.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -31,7 +31,7 @@ Description
This boundary condition maps the velocity and flux from a neighbour patch
to this patch
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -32,7 +32,7 @@ Description
moving walls. In addition, it should also be applied to 'moving' walls
for moving reference frame (MRF) calculations.
\heading Patch usage
Usage
Example of the boundary condition specification:
\verbatim

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

@ -30,7 +30,7 @@ Group
Description
This boundary condition fixes the velocity to zero at walls.
\heading Patch usage
Usage
Example of the boundary condition specification:
\verbatim

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

@ -31,7 +31,7 @@ Description
This boundary condition provides a generic inflow condition, with
specified outflow for the case of reverse flow.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -32,7 +32,7 @@ Description
by name "outletPatchName" and applies this as the uniform value of the
field over this patch.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -35,7 +35,7 @@ Description
Typical usage is as the outlet condition for a towing-tank ship simulation
to maintain the outlet water level at the level as the inlet.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value
Umean | mean velocity normal to the boundary [m/s] | yes |

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

@ -31,7 +31,7 @@ Description
This boundary condition provides a partial slip condition. The amount of
slip is controlled by a user-supplied field.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -48,7 +48,7 @@ Description
- 1: apply \$fp_{hyd}\$f
- 0: apply a zero-gradient condition
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -63,7 +63,7 @@ Description
Chapter 4, Section 4.3.1.2, 77-80.
\endverbatim
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -33,7 +33,7 @@ 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
Usage
\table
Property | Description | Required | Default value

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

@ -32,7 +32,7 @@ Description
pressure is specified. The inflow velocity is obtained from the flux with
the specified inlet direction" direction.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -35,7 +35,7 @@ Description
A slip condition is applied tangential to the patch.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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

@ -35,7 +35,7 @@ Description
The tangential patch velocity can be optionally specified.
\heading Patch usage
Usage
\table
Property | Description | Required | Default value

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
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
Usage
Example of the boundary condition specification:
\verbatim

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