From 71fdcab77110f6e75085492cb8e21dad6082485a Mon Sep 17 00:00:00 2001 From: Henry Weller <http://cfd.direct> Date: Sun, 19 Jun 2016 21:23:54 +0100 Subject: [PATCH] Updated header documentation processed by Doxygen --- .../BCs/rho/fixedRhoFvPatchScalarField.H | 3 +-- ...ayatillekeWallFunctionFvPatchScalarField.H | 3 +-- doc/codingStyleGuide.org | 2 +- etc/codeTemplates/BC/BC.H | 3 +-- .../functionObject/functionObject.H | 16 ++++++------- ...convectiveHeatTransferFvPatchScalarField.H | 3 +-- ...oupledTemperatureMixedFvPatchScalarField.H | 3 +-- ...allHeatFluxTemperatureFvPatchScalarField.H | 3 +-- .../thermalBaffle1DFvPatchScalarField.H | 23 ++++++++----------- ...entHeatFluxTemperatureFvPatchScalarField.H | 1 - ...tureCoupledBaffleMixedFvPatchScalarField.H | 3 +-- ...eratureRadCoupledMixedFvPatchScalarField.H | 3 +-- ...ayatillekeWallFunctionFvPatchScalarField.H | 3 +-- .../alphatWallFunctionFvPatchScalarField.H | 3 +-- .../wallHeatTransferFvPatchScalarField.H | 3 +-- ...ayatillekeWallFunctionFvPatchScalarField.H | 3 +-- .../atmBoundaryLayer/atmBoundaryLayer.H | 1 - ...thDissipationRateInletFvPatchScalarField.H | 3 +-- ...ngLengthFrequencyInletFvPatchScalarField.H | 3 +-- .../porousBafflePressureFvPatchField.H | 3 +-- ...silonLowReWallFunctionFvPatchScalarField.H | 3 +-- .../epsilonWallFunctionFvPatchScalarField.H | 3 +-- .../fWallFunctionFvPatchScalarField.H | 3 +-- .../kLowReWallFunctionFvPatchScalarField.H | 3 +-- .../kqRWallFunctionFvPatchField.H | 3 +-- .../nutLowReWallFunctionFvPatchScalarField.H | 3 +-- .../nutURoughWallFunctionFvPatchScalarField.H | 3 +-- ...tUSpaldingWallFunctionFvPatchScalarField.H | 3 +-- ...UTabulatedWallFunctionFvPatchScalarField.H | 3 +-- .../nutUWallFunctionFvPatchScalarField.H | 3 +-- .../nutWallFunctionFvPatchScalarField.H | 3 +-- ...tkAtmRoughWallFunctionFvPatchScalarField.H | 3 +-- .../nutkRoughWallFunctionFvPatchScalarField.H | 3 +-- .../nutkWallFunctionFvPatchScalarField.H | 3 +-- .../omegaWallFunctionFvPatchScalarField.H | 3 +-- .../v2WallFunctionFvPatchScalarField.H | 3 +-- .../SRFFreestreamVelocityFvPatchVectorField.H | 3 +-- .../SRFVelocityFvPatchVectorField.H | 3 +-- .../SRFWallVelocityFvPatchVectorField.H | 3 +-- .../basic/calculated/calculatedFvPatchField.H | 3 +-- .../extrapolatedCalculatedFvPatchField.H | 3 +-- .../fixedGradient/fixedGradientFvPatchField.H | 3 +-- .../basic/fixedValue/fixedValueFvPatchField.H | 3 +-- .../basic/mixed/mixedFvPatchField.H | 1 - .../zeroGradient/zeroGradientFvPatchField.H | 3 +-- .../constraint/cyclic/cyclicFvPatchField.H | 3 +-- .../cyclicACMI/cyclicACMIFvPatchField.H | 3 +-- .../cyclicAMI/cyclicAMIFvPatchField.H | 3 +-- .../cyclicSlip/cyclicSlipFvPatchField.H | 3 +-- .../constraint/empty/emptyFvPatchField.H | 3 +-- .../processor/processorFvPatchField.H | 3 +-- .../processorCyclicFvPatchField.H | 3 +-- .../symmetry/symmetryFvPatchField.H | 3 +-- .../symmetryPlane/symmetryPlaneFvPatchField.H | 3 +-- .../constraint/wedge/wedgeFvPatchField.H | 3 +-- .../activeBaffleVelocityFvPatchVectorField.H | 3 +-- ...ureForceBaffleVelocityFvPatchVectorField.H | 3 +-- .../derived/advective/advectiveFvPatchField.H | 3 +-- .../codedFixedValueFvPatchField.H | 5 ++-- .../codedMixed/codedMixedFvPatchField.H | 5 ++-- ...lindricalInletVelocityFvPatchVectorField.H | 3 +-- .../externalCoupledMixedFvPatchField.H | 3 +-- .../derived/fan/fanFvPatchField.H | 3 +-- .../fanPressureFvPatchScalarField.H | 1 - ...uxExtrapolatedPressureFvPatchScalarField.H | 2 +- .../fixedFluxPressureFvPatchScalarField.H | 2 +- .../fixedInternalValueFvPatchField.H | 3 +-- .../derived/fixedJump/fixedJumpFvPatchField.H | 3 +-- .../fixedJumpAMI/fixedJumpAMIFvPatchField.H | 3 +-- .../derived/fixedMean/fixedMeanFvPatchField.H | 3 +-- ...malInletOutletVelocityFvPatchVectorField.H | 3 +-- .../fixedNormalSlipFvPatchField.H | 3 +-- ...ureCompressibleDensityFvPatchScalarField.H | 3 +-- .../fixedProfile/fixedProfileFvPatchField.H | 3 +-- .../flowRateInletVelocityFvPatchVectorField.H | 4 ++-- .../fluxCorrectedVelocityFvPatchVectorField.H | 2 +- .../freestream/freestreamFvPatchField.H | 3 +-- .../freestreamPressureFvPatchScalarField.H | 3 +-- .../inletOutlet/inletOutletFvPatchField.H | 3 +-- ...OutletTotalTemperatureFvPatchScalarField.H | 3 +-- .../mappedField/mappedFieldFvPatchField.H | 3 +-- .../mappedFixedInternalValueFvPatchField.H | 3 +-- ...ppedFixedPushedInternalValueFvPatchField.H | 3 +-- .../mappedFixedValueFvPatchField.H | 3 +-- .../mappedFlowRateFvPatchVectorField.H | 3 +-- ...mappedVelocityFluxFixedValueFvPatchField.H | 3 +-- .../movingWallVelocityFvPatchVectorField.H | 3 +-- .../derived/noSlip/noSlipFvPatchVectorField.H | 3 +-- .../outletInlet/outletInletFvPatchField.H | 3 +-- .../outletMappedUniformInletFvPatchField.H | 3 +-- ...utletPhaseMeanVelocityFvPatchVectorField.H | 2 +- .../partialSlip/partialSlipFvPatchField.H | 3 +-- ...aseHydrostaticPressureFvPatchScalarField.H | 3 +-- .../plenumPressureFvPatchScalarField.H | 3 +-- ...tedInletOutletVelocityFvPatchVectorField.H | 3 +-- ...eDirectedInletVelocityFvPatchVectorField.H | 3 +-- ...tOutletParSlipVelocityFvPatchVectorField.H | 3 +-- ...ureInletOutletVelocityFvPatchVectorField.H | 3 +-- ...reInletUniformVelocityFvPatchVectorField.H | 3 +-- .../pressureInletVelocityFvPatchVectorField.H | 3 +-- ...malInletOutletVelocityFvPatchVectorField.H | 3 +-- .../prghPressureFvPatchScalarField.H | 3 +-- ...talHydrostaticPressureFvPatchScalarField.H | 3 +-- .../prghTotalPressureFvPatchScalarField.H | 3 +-- ...ureInletOutletVelocityFvPatchVectorField.H | 3 +-- .../rotatingTotalPressureFvPatchScalarField.H | 3 +-- .../rotatingWallVelocityFvPatchVectorField.H | 3 +-- .../derived/slip/slipFvPatchField.H | 3 +-- .../supersonicFreestreamFvPatchVectorField.H | 3 +-- ...urfaceNormalFixedValueFvPatchVectorField.H | 3 +-- ...lFlowRateInletVelocityFvPatchVectorField.H | 3 +-- .../syringePressureFvPatchScalarField.H | 3 +-- .../timeVaryingMappedFixedValueFvPatchField.H | 3 +-- .../totalPressureFvPatchScalarField.H | 3 +-- .../totalTemperatureFvPatchScalarField.H | 3 +-- ...ranslatingWallVelocityFvPatchVectorField.H | 3 +-- .../turbulentInletFvPatchField.H | 3 +-- ...sityKineticEnergyInletFvPatchScalarField.H | 3 +-- ...ityHydrostaticPressureFvPatchScalarField.H | 3 +-- .../uniformFixedGradientFvPatchField.H | 3 +-- .../uniformFixedValueFvPatchField.H | 3 +-- .../uniformInletOutletFvPatchField.H | 3 +-- .../uniformJump/uniformJumpFvPatchField.H | 3 +-- .../uniformJumpAMIFvPatchField.H | 3 +-- .../uniformTotalPressureFvPatchScalarField.H | 3 +-- .../variableHeightFlowRateFvPatchField.H | 3 +-- ...tFlowRateInletVelocityFvPatchVectorField.H | 3 +-- .../waveSurfacePressureFvPatchScalarField.H | 3 +-- .../waveTransmissiveFvPatchField.H | 3 +-- .../lagrangian/cloudInfo/cloudInfo.H | 1 - ...polatedDisplacementPointPatchVectorField.H | 1 - .../actuationDiskSource/actuationDiskSource.H | 1 - .../effectivenessHeatExchangerSource.H | 1 - .../explicitPorositySource.H | 1 - .../radialActuationDiskSource.H | 1 - .../derived/rotorDiskSource/rotorDiskSource.H | 1 - .../tabulatedAccelerationSource.H | 1 - .../sources/general/codedSource/CodedSource.H | 1 - ...ysisTemperatureCoupledFvPatchScalarField.H | 2 +- ...rolysisVelocityCoupledFvPatchVectorField.H | 2 +- ...ilmHeightInletVelocityFvPatchVectorField.H | 3 +-- ...alphatFilmWallFunctionFvPatchScalarField.H | 3 +-- .../nutkFilmWallFunctionFvPatchScalarField.H | 3 +-- .../thermalBaffleFvPatchScalarField.H | 7 ++---- .../fixedEnergyFvPatchScalarField.H | 3 +-- .../gradientEnergyFvPatchScalarField.H | 3 +-- .../MarshakRadiationFvPatchScalarField.H | 3 +-- ...iationFixedTemperatureFvPatchScalarField.H | 3 +-- ...iffusiveRadiationMixedFvPatchScalarField.H | 3 +-- ...veViewFactorFixedValueFvPatchScalarField.H | 3 +-- ...iffusiveRadiationMixedFvPatchScalarField.H | 3 +-- .../alphaContactAngleFvPatchScalarField.H | 2 +- ...ndentAlphaContactAngleFvPatchScalarField.H | 3 +-- .../triSurface/interfaces/AC3D/writeAC.C | 12 +++++----- .../triSurface/interfaces/DX/writeDX.C | 16 ++++++------- .../triSurface/interfaces/GTS/writeGTS.C | 10 ++++---- .../triSurface/interfaces/OBJ/writeOBJ.C | 20 ++++++++-------- .../triSurface/interfaces/OFF/writeOFF.C | 10 ++++---- .../triSurface/interfaces/SMESH/writeSMESH.C | 6 ++--- .../triSurface/interfaces/STL/writeSTL.C | 18 +++++++-------- .../triSurface/interfaces/TRI/writeTRI.C | 6 ++--- .../triSurface/interfaces/VTK/writeVTK.C | 10 ++++---- 162 files changed, 214 insertions(+), 361 deletions(-) diff --git a/applications/solvers/compressible/rhoCentralFoam/BCs/rho/fixedRhoFvPatchScalarField.H b/applications/solvers/compressible/rhoCentralFoam/BCs/rho/fixedRhoFvPatchScalarField.H index 5779d86b922..0e2e83eb749 100644 --- a/applications/solvers/compressible/rhoCentralFoam/BCs/rho/fixedRhoFvPatchScalarField.H +++ b/applications/solvers/compressible/rhoCentralFoam/BCs/rho/fixedRhoFvPatchScalarField.H @@ -45,7 +45,6 @@ Description Usage - \table Property | Description | Required | Default value p | Pressure field name | no | p @@ -54,7 +53,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fixedRho; } diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H index bdf3153c33b..8b0e39b8823 100755 --- a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H +++ b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/twoPhaseCompressibleTurbulenceModels/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.H @@ -34,7 +34,6 @@ Description the Eulerian multiphase solvers. Usage - \table Property | Description | Required | Default value Prt | Turbulent Prandtl number | no | 0.85 @@ -45,7 +44,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type alphatPhaseChangeJayatillekeWallFunction; Prt 0.85; diff --git a/doc/codingStyleGuide.org b/doc/codingStyleGuide.org index fa25fa6fc77..43e42c4361f 100644 --- a/doc/codingStyleGuide.org +++ b/doc/codingStyleGuide.org @@ -427,7 +427,7 @@ \verbatim patchName { - type myPatchType; + type patchType; refValue 100; value uniform 1; } diff --git a/etc/codeTemplates/BC/BC.H b/etc/codeTemplates/BC/BC.H index 1727dc016fb..c878d68d9d4 100644 --- a/etc/codeTemplates/BC/BC.H +++ b/etc/codeTemplates/BC/BC.H @@ -44,7 +44,6 @@ Description \endtable Usage - \table Property | Description | Req'd? | Default scalarData | single scalar value | yes | @@ -56,7 +55,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type NAME; scalarData -1; diff --git a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H index fa407cce12e..2405cac9daa 100644 --- a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H +++ b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H @@ -42,10 +42,10 @@ Description \verbatim functions { - myFunctionObject // Name of functionObject entry + <functionObjectName> { type functionObjectType; - libs ("libMyFunctionObjectlib.so"); + libs ("libMyFunctionObjectlib.so"); region defaultRegion; enabled yes; timeStart 0; @@ -84,12 +84,12 @@ Description none | Execute/write every time-step \endtable - The sub-dictionary name \c myFunctionObject is chosen by the user, and is - typically used as the name of the output directory for any data written by - the functionObject. The \c type entry defines the type of function object - properties that follow. FunctionObjects are packaged into separate - libraries and the \c libs entry is used to specify which library - should be loaded. + The sub-dictionary name \c <functionObjectName> is chosen by the user, and + is typically used as the name of the output directory for any data written + by the functionObject. The \c type entry defines the type of function + object properties that follow. FunctionObjects are packaged into separate + libraries and the \c libs entry is used to specify which library should be + loaded. Class Foam::functionObject diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H index 90eba83b1ec..3a3b61fb3ac 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H @@ -51,7 +51,6 @@ Description \endvartable Usage - \table Property | Description | Required | Default value L | Length scale [m] | yes | @@ -59,7 +58,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type convectiveHeatTransfer; L 0.1; diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H index ad63aa6526a..0fd335ea88f 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalCoupledTemperatureMixed/externalCoupledTemperatureMixedFvPatchScalarField.H @@ -84,7 +84,6 @@ Description Usage - \table Property | Description | Required | Default value commsDir | communications directory | yes | @@ -97,7 +96,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type externalCoupledTemperature; commsDir "$FOAM_CASE/comms"; diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H index 0caa3cb406e..a01786738a1 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/externalWallHeatFluxTemperature/externalWallHeatFluxTemperatureFvPatchScalarField.H @@ -49,7 +49,6 @@ Description thermophysical package. Usage - \table Property | Description | Required | Default value kappa | thermal conductivity option | yes | @@ -65,7 +64,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type externalWallHeatFluxTemperature; kappa fluidThermo; diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/thermalBaffle1D/thermalBaffle1DFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/thermalBaffle1D/thermalBaffle1DFvPatchScalarField.H index ac3464e1b99..23dedf0b07b 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/thermalBaffle1D/thermalBaffle1DFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/thermalBaffle1D/thermalBaffle1DFvPatchScalarField.H @@ -28,23 +28,22 @@ Group grpThermoBoundaryConditions Description + This BC solves a steady 1D thermal baffle. - This BC solves a steady 1D thermal baffle. The solid properties are - specify as dictionary. Optionaly radiative heat flux (Qr) can be - incorporated into the balance. Some under-relaxation might be needed on - Qr. - Baffle and solid properties need to be specified on the master side - of the baffle. + The solid properties are specify as dictionary. Optionaly radiative heat + flux (Qr) can be incorporated into the balance. Some under-relaxation might + be needed on Qr. Baffle and solid properties need to be specified on the + master side of the baffle. Usage Example of the boundary condition specification using constant solid thermo : \verbatim - myPatch_master + <masterPatchName> { type compressible::thermalBaffle1D<hConstSolidThermoPhysics>; - samplePatch myPatch_slave; + samplePatch <slavePatchName>; thickness uniform 0.005; // thickness [m] Qs uniform 100; // heat flux [W/m2] @@ -75,18 +74,16 @@ Usage value uniform 300; } - myPatch_slave + <slavePatchName> { type compressible::thermalBaffle1D<hConstSolidThermoPhysics>; - samplePatch myPatch_master_master; + samplePatch <masterPatchName>; Qr none; relaxation 1; } \endverbatim - - SourceFiles thermalBaffle1DFvPatchScalarField.C @@ -131,7 +128,7 @@ class thermalBaffle1DFvPatchScalarField mutable scalarField Qs_; //- Solid dictionary - dictionary solidDict_; + dictionary solidDict_; //- Solid thermo mutable autoPtr<solidType> solidPtr_; diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H index 5a9d914e066..c164c41ce3d 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H @@ -30,7 +30,6 @@ Description flux [W/m^2]. Usage - \table Property | Description | Required | Default value heatSource | 'power' [W] or 'flux' [W/m^2] | yes | diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H index 7c6fb3ac2b9..2a5afaaf8ca 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H @@ -43,7 +43,6 @@ Description where KDelta is heat-transfer coefficient K * deltaCoeffs Usage - \table Property | Description | Required | Default value kappa | thermal conductivity option | yes | @@ -55,7 +54,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type compressible::turbulentTemperatureCoupledBaffleMixed; Tnbr T; diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H index 6c9413dcd40..e15a24047ee 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H @@ -36,7 +36,6 @@ Description or \c fluidThermo thermophysical package. Usage - \table Property | Description | Required | Default value kappa | thermal conductivity option | yes | @@ -50,7 +49,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type compressible::turbulentTemperatureRadCoupledMixed; Tnbr T; diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H index f932003f727..392ec0fd0ba 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H @@ -32,7 +32,6 @@ Description thermal diffusivity (usually\c alphat) based on the Jayatilleke model. Usage - \table Property | Description | Required | Default value Prt | turbulent Prandtl number | no | 0.85 @@ -43,7 +42,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type alphatJayatillekeWallFunction; Prt 0.85; diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H index d937a1f2ef5..ca4c35bc5d5 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatWallFunction/alphatWallFunctionFvPatchScalarField.H @@ -47,7 +47,6 @@ Description \endvartable Usage - \table Property | Description | Required | Default value nut | turbulence viscosity field name | no | nut @@ -56,7 +55,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type alphatWallFunction; nut nut; diff --git a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H index d6a9d443e35..ec12b1d57a8 100644 --- a/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H +++ b/src/TurbulenceModels/compressible/turbulentFluidThermoModels/derivedFvPatchFields/wallHeatTransfer/wallHeatTransferFvPatchScalarField.H @@ -32,7 +32,6 @@ Description transfer Usage - \table Property | Description | Required | Default value Tinf | wall temperature | yes | @@ -41,7 +40,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type wallHeatTransfer; Tinf uniform 500; diff --git a/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H index 1b718f983c1..5af8fe5f839 100644 --- a/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/incompressible/turbulentTransportModels/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H @@ -32,7 +32,6 @@ Description for using wall functions, using the Jayatilleke 'P' function. Usage - \table Property | Description | Required | Default value Prt | turbulent Prandtl number | no | 0.85 @@ -43,7 +42,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type alphatJayatillekeWallFunction; } diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H index 1ce35ddf429..8fddacb2213 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/atmBoundaryLayer/atmBoundaryLayer.H @@ -75,7 +75,6 @@ Description 95(2007), pp 355-369. Usage - \table Property | Description | Required | Default flowDir | Flow direction | yes | diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H index eaf7aa8a4e0..d71c85ea810 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthDissipationRateInlet/turbulentMixingLengthDissipationRateInletFvPatchScalarField.H @@ -46,7 +46,6 @@ Description \endvartable Usage - \table Property | Description | Required | Default value mixingLength | Length scale [m] | yes | @@ -56,7 +55,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type turbulentMixingLengthDissipationRateInlet; mixingLength 0.005; diff --git a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H index 9d2cc294e13..9ee1dfac1a9 100644 --- a/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/RAS/derivedFvPatchFields/turbulentMixingLengthFrequencyInlet/turbulentMixingLengthFrequencyInletFvPatchScalarField.H @@ -46,7 +46,6 @@ Description \endvartable Usage - \table Property | Description | Required | Default value mixingLength | Length scale [m] | yes | @@ -56,7 +55,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type turbulentMixingLengthFrequencyInlet; mixingLength 0.005; diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H index b14f4a41051..db5c43a1404 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H @@ -50,7 +50,6 @@ Description Usage - \table Property | Description | Required | Default value patchType | underlying patch type should be \c cyclic| yes | @@ -63,7 +62,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type porousBafflePressure; patchType cyclic; diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H index 21c5f12db59..af62657f8a8 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonLowReWallFunction/epsilonLowReWallFunctionFvPatchScalarField.H @@ -39,7 +39,6 @@ Description switch-over y+ value derived from kappa and E. Usage - \table Property | Description | Required | Default value Cmu | model coefficient | no | 0.09 @@ -49,7 +48,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type epsilonLowReWallFunction; } diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H index d77dadc3e77..9e8ace814a2 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/epsilonWallFunctions/epsilonWallFunction/epsilonWallFunctionFvPatchScalarField.H @@ -44,7 +44,6 @@ Description \endvartable Usage - \table Property | Description | Required | Default value Cmu | model coefficient | no | 0.09 @@ -54,7 +53,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type epsilonWallFunction; } diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/fWallFunctions/fWallFunction/fWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/fWallFunctions/fWallFunction/fWallFunctionFvPatchScalarField.H index 5d627780139..3e6580cfd82 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/fWallFunctions/fWallFunction/fWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/fWallFunctions/fWallFunction/fWallFunctionFvPatchScalarField.H @@ -35,7 +35,6 @@ Description switch-over y+ value derived from kappa and E. Usage - \table Property | Description | Required | Default value Cmu | model coefficient | no | 0.09 @@ -45,7 +44,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fWallFunction; } diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H index 02a3bd7ef4d..72977684dec 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kLowReWallFunction/kLowReWallFunctionFvPatchScalarField.H @@ -35,7 +35,6 @@ Description switch-over y+ value derived from kappa and E. Usage - \table Property | Description | Required | Default value Cmu | model coefficient | no | 0.09 @@ -46,7 +45,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type kLowReWallFunction; } diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H index 1fdfe933dfb..006f06b170c 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H @@ -35,10 +35,9 @@ Description It is a simple wrapper around the zero-gradient condition. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type kqRWallFunction; } diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H index c1acfded6bb..5468624828c 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H @@ -33,10 +33,9 @@ Description provides an access function to calculate y+. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type nutLowReWallFunction; } diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H index 7958e26817a..b88b2521285 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H @@ -32,7 +32,6 @@ Description when using wall functions for rough walls, based on velocity. Usage - \table Property | Description | Required | Default value roughnessHeight | roughness height | yes | @@ -42,7 +41,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type nutURoughWallFunction; roughnessHeight 1e-5; diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H index dda5793e1e7..c7730147833 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H @@ -46,10 +46,9 @@ Description Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type nutUSpaldingWallFunction; } diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H index 477872fbf19..86cf0d4b32f 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUTabulatedWallFunction/nutUTabulatedWallFunctionFvPatchScalarField.H @@ -34,7 +34,6 @@ Description located in the $FOAM_CASE/constant directory. Usage - \table Property | Description | Required | Default value uPlusTable | U+ as a function of Re table name | yes | @@ -42,7 +41,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type nutTabulatedWallFunction; uPlusTable myUPlusTable; diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H index d3fbbeb2f78..f93ba98d3d3 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H @@ -32,10 +32,9 @@ Description when using wall functions, based on velocity. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type nutUWallFunction; } diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H index ab06f04d6c8..56b73e2241c 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H @@ -33,7 +33,6 @@ Description - replicates OpenFOAM v1.5 (and earlier) behaviour Usage - \table Property | Description | Required | Default value Cmu | Cmu coefficient | no | 0.09 @@ -43,7 +42,7 @@ Usage Examples of the boundary condition specification: \verbatim - myPatch + <patchName> { type nutWallFunction; value uniform 0.0; diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H index 2704c4c97f9..a96dfb7ae0f 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H @@ -47,7 +47,6 @@ Description \endvartable Usage - \table Property | Description | Required | Default value z0 | surface roughness length| yes | @@ -55,7 +54,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type nutkAtmRoughWallFunction; z0 uniform 0; diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H index 99983355081..1eba8523ce4 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H @@ -38,7 +38,6 @@ Description - roughness constant = 0.5-1.0 Usage - \table Property | Description | Required | Default value Ks | sand-grain roughness height | yes | @@ -47,7 +46,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type nutkRoughWallFunction; Ks uniform 0; diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H index 5247fd7b2b2..fab8f67b426 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H @@ -33,10 +33,9 @@ Description - replicates OpenFOAM v1.5 (and earlier) behaviour Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type nutkWallFunction; } diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H index 51ec6bb5372..83b25df36ad 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H @@ -51,7 +51,6 @@ Description \endverbatim Usage - \table Property | Description | Required | Default value Cmu | model coefficient | no | 0.09 @@ -62,7 +61,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type omegaWallFunction; } diff --git a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/v2WallFunctions/v2WallFunction/v2WallFunctionFvPatchScalarField.H b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/v2WallFunctions/v2WallFunction/v2WallFunctionFvPatchScalarField.H index 1055a5a5d4f..83efeab5623 100644 --- a/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/v2WallFunctions/v2WallFunction/v2WallFunctionFvPatchScalarField.H +++ b/src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/v2WallFunctions/v2WallFunction/v2WallFunctionFvPatchScalarField.H @@ -37,7 +37,6 @@ Description Usage - \table Property | Description | Required | Default value Cmu | model coefficient | no | 0.09 @@ -47,7 +46,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type v2WallFunction; } diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H index dabab17c64f..8560c5edfcf 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H @@ -47,7 +47,6 @@ Description Usage - \table Property | Description | Required | Default value UInf | freestream velocity | yes | @@ -56,7 +55,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type SRFFreestreamVelocity; UInf uniform (0 0 0); diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H index 2eeae499a92..cdf96caba79 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H @@ -59,7 +59,6 @@ Description Usage - \table Property | Description | Required | Default value inletValue | inlet velocity | yes | @@ -68,7 +67,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type SRFVelocity; inletValue uniform (0 0 0); diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFWallVelocityFvPatchVectorField/SRFWallVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFWallVelocityFvPatchVectorField/SRFWallVelocityFvPatchVectorField.H index 5f967c33694..4c3101993ee 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFWallVelocityFvPatchVectorField/SRFWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFWallVelocityFvPatchVectorField/SRFWallVelocityFvPatchVectorField.H @@ -48,10 +48,9 @@ Description if the wall patch faces are irregular. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type SRFWallVelocity; value uniform (0 0 0); // Initial value diff --git a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H index ad7b3682238..de6ae1ac6f6 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/calculated/calculatedFvPatchField.H @@ -33,10 +33,9 @@ Description e.g. \c updateCoeffs or \c evaluate. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type calculated; value uniform (0 0 0); // Required value entry diff --git a/src/finiteVolume/fields/fvPatchFields/basic/extrapolatedCalculated/extrapolatedCalculatedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/extrapolatedCalculated/extrapolatedCalculatedFvPatchField.H index 5ba454dd27d..da998d3a85d 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/extrapolatedCalculated/extrapolatedCalculatedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/extrapolatedCalculated/extrapolatedCalculatedFvPatchField.H @@ -34,10 +34,9 @@ Description internal and patch field values rather than returning zero. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type extrapolatedCalculated; } diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H index 30572201883..622a52fcdea 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedGradient/fixedGradientFvPatchField.H @@ -44,7 +44,6 @@ Description \endvartable Usage - \table Property | Description | Required | Default value gradient | gradient | yes | @@ -52,7 +51,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fixedGradient; gradient uniform 0; diff --git a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H index c210f17e084..3cf2421420d 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/fixedValue/fixedValueFvPatchField.H @@ -32,7 +32,6 @@ Description class for a number of other boundary conditions. Usage - \table Property | Description | Required | Default value value | Patch face values | yes | @@ -40,7 +39,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fixedValue; value uniform 0; // Example for scalar field usage diff --git a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H index b51e69adcc6..1da39dc1989 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H @@ -49,7 +49,6 @@ Description Usage - \table Property | Description | Required | Default value valueFraction | weight field | yes | diff --git a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H index 049e1f86fc1..c8c1ec4b507 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H @@ -32,10 +32,9 @@ Description internal field onto the patch faces. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type zeroGradient; } diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H index 06975886b85..8122c211390 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclic/cyclicFvPatchField.H @@ -32,10 +32,9 @@ Description boundaries. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type cyclic; } diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicACMI/cyclicACMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicACMI/cyclicACMIFvPatchField.H index b371c900282..ebb2fb8cbd2 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicACMI/cyclicACMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicACMI/cyclicACMIFvPatchField.H @@ -33,10 +33,9 @@ Description an arbitrarily coupled mesh interface (ACMI) interpolation. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type cyclicACMI; } diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H index ef5cdcc961d..7ad7bddbb40 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicAMI/cyclicAMIFvPatchField.H @@ -33,10 +33,9 @@ Description an arbitrary mesh interface (AMI) interpolation. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type cyclicAMI; } diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H index 57a5f7df2e2..9645916cbd5 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/cyclicSlip/cyclicSlipFvPatchField.H @@ -32,10 +32,9 @@ Description condition, providing no new functionality. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type cyclicSlip; } diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H index 017acb422c1..b6b90e98a7f 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/empty/emptyFvPatchField.H @@ -34,10 +34,9 @@ Description constitue solution directions. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type empty; } diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H index ddb4c5deeac..bfe1b75708a 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/processor/processorFvPatchField.H @@ -31,10 +31,9 @@ Description This boundary condition enables processor communication across patches. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type processor; } diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H index bdc81a727bc..1f492a95cb5 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/processorCyclic/processorCyclicFvPatchField.H @@ -32,10 +32,9 @@ Description patches. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type processor; } diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H index 8e988347d96..ef808b36c6b 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/symmetry/symmetryFvPatchField.H @@ -31,10 +31,9 @@ Description This boundary condition enforces a symmetry constraint Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type symmetry; } diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/symmetryPlane/symmetryPlaneFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/symmetryPlane/symmetryPlaneFvPatchField.H index 1dfb805c6e6..ab6057d9dee 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/symmetryPlane/symmetryPlaneFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/symmetryPlane/symmetryPlaneFvPatchField.H @@ -31,10 +31,9 @@ Description This boundary condition enforces a symmetryPlane constraint Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type symmetryPlane; } diff --git a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H index d8aef9e6ef9..eab75d121a2 100644 --- a/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/constraint/wedge/wedgeFvPatchField.H @@ -32,10 +32,9 @@ Description it is applied to 2-D geometries. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type wedge; } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H index b4639cf184f..e720cadc79d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activeBaffleVelocity/activeBaffleVelocityFvPatchVectorField.H @@ -55,7 +55,6 @@ Description The open fraction is then applied to scale the patch areas. Usage - \table Property | Description | Required | Default value p | pressure field name | no | p @@ -68,7 +67,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type activeBaffleVelocity; p p; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H index 25396f644b1..f645c0257f8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/activePressureForceBaffleVelocity/activePressureForceBaffleVelocityFvPatchVectorField.H @@ -58,7 +58,6 @@ Description The open fraction is then applied to scale the patch areas. Usage - \table Property | Description | Required | Default value p | pressure field name | no | p @@ -74,7 +73,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type activePressureForceBaffleVelocity; p p; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H index 10dfd789883..e5caf978687 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/advective/advectiveFvPatchField.H @@ -49,7 +49,6 @@ Description transmissive boundary condition. Usage - \table Property | Description | Required | Default value phi | flux field name | no | phi @@ -60,7 +59,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type advective; phi phi; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H index 9b7097b44d3..e8f7453d4dc 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedFixedValue/codedFixedValueFvPatchField.H @@ -32,10 +32,9 @@ Description fixedValueFvPatchField) which is then used to evaluate. Usage - Example: \verbatim - myPatch + <patchName> { type codedFixedValue; value uniform 0; @@ -63,7 +62,7 @@ Usage which would have a corresponding entry: \verbatim - myPatch + <patchName> { code #{ diff --git a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H index 7484cbc8003..37b20c9c457 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H @@ -32,10 +32,9 @@ Description mixedFvPatchField) which is then used to evaluate. Usage - Example: \verbatim - myPatch + <patchName> { type codedMixed; @@ -71,7 +70,7 @@ Usage which would have a corresponding entry \verbatim - myPatch + <patchName> { code #{ diff --git a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H index 1a2843d41f5..feaf17f0c1a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/cylindricalInletVelocity/cylindricalInletVelocityFvPatchVectorField.H @@ -33,7 +33,6 @@ Description and radial velocity. Usage - \table Property | Description | Required | Default value axis | axis of rotation | yes | @@ -45,7 +44,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type cylindricalInletVelocity; axis (0 0 1); diff --git a/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H index b5dc098aef9..190ff28e5c9 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/externalCoupledMixed/externalCoupledMixedFvPatchField.H @@ -84,7 +84,6 @@ Description Usage - \table Property | Description | Required | Default value commsDir | communications directory | yes | @@ -98,7 +97,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type externalCoupled; commsDir "$FOAM_CASE/comms"; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index 2bda5a59890..301db5d0d66 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -35,7 +35,6 @@ Description contant, polynomial, table values. Usage - \table Property | Description | Required | Default value patchType | underlying patch type should be \c cyclic| yes | @@ -46,7 +45,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fan; patchType cyclic; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H index 74b69ab133b..aa4b19f28b8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H @@ -32,7 +32,6 @@ Description or outlet total pressure condition for a fan. Usage - \table Property | Description | Required | Default value fileName | fan curve file name | yes | diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxExtrapolatedPressure/fixedFluxExtrapolatedPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxExtrapolatedPressure/fixedFluxExtrapolatedPressureFvPatchScalarField.H index 382d6b3dba3..1bdaee71b8a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxExtrapolatedPressure/fixedFluxExtrapolatedPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxExtrapolatedPressure/fixedFluxExtrapolatedPressureFvPatchScalarField.H @@ -34,7 +34,7 @@ Description Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fixedFluxExtrapolatedPressure; } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H index f60932280d1..aa34bf66372 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedFluxPressure/fixedFluxPressureFvPatchScalarField.H @@ -34,7 +34,7 @@ Description Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fixedFluxPressure; } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H index 7870fa71269..4b1b997be56 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedInternalValueFvPatchField/fixedInternalValueFvPatchField.H @@ -33,10 +33,9 @@ Description behaviour is to act as a zero gradient condition. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fixedInternalValue; value uniform 0; // place holder diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H index 6f81586f177..48d8ecbde0c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H @@ -35,7 +35,6 @@ Description 'owner' patch. Usage - \table Property | Description | Required | Default value patchType | underlying patch type should be \c cyclic| yes | @@ -44,7 +43,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fixedJump; patchType cyclic; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H index 7e5ebaa86af..66e892ff986 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H @@ -35,7 +35,6 @@ Description 'owner' patch. Usage - \table Property | Description | Required | Default value patchType | underlying patch type should be \c cyclic| yes | @@ -44,7 +43,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fixedJumpAMI; patchType cyclic; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H index f3fc4d9128e..ab356135c6e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedMean/fixedMeanFvPatchField.H @@ -33,7 +33,6 @@ Description time-varying, mean value. Usage - \table Property | Description | Required | Default value meanValue | mean value Function1 | yes | @@ -41,7 +40,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fixedMean; meanValue 1.0; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalInletOutletVelocity/fixedNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalInletOutletVelocity/fixedNormalInletOutletVelocityFvPatchVectorField.H index 6ce56ecfe10..95b45a82d8c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalInletOutletVelocity/fixedNormalInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalInletOutletVelocity/fixedNormalInletOutletVelocityFvPatchVectorField.H @@ -42,7 +42,6 @@ Description apply zero-gradient condition to tangential components. Usage - \table Property | Description | Required | Default value phi | flux field name | no | phi @@ -52,7 +51,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fixedNormalInletOutletVelocity; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H index 48391c4e4eb..93c11806223 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalSlip/fixedNormalSlipFvPatchField.H @@ -31,7 +31,6 @@ Description This boundary condition sets the patch-normal component to a fixed value. Usage - \table Property | Description | Required | Default value fixedValue | fixed value | yes | @@ -39,7 +38,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fixedNormalSlip; fixedValue uniform 0; // example entry for a scalar field diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H index 98d701efab7..a13f1198432 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedPressureCompressibleDensity/fixedPressureCompressibleDensityFvPatchScalarField.H @@ -49,7 +49,6 @@ Description \c thermodynamicProperties dictionary. Usage - \table Property | Description | Required | Default value p | pressure field name | no | p @@ -57,7 +56,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fixedPressureCompressibleDensity; p p; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H index 15d7af290bf..502be93b545 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedProfile/fixedProfileFvPatchField.H @@ -31,7 +31,6 @@ Description This boundary condition provides a fixed value profile condition. Usage - \table Property | Description | Required | Default value profile | Profile Function1 | yes | @@ -41,7 +40,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fixedProfile; profile csvFile; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H index 09f627ebcf4..286004f97bf 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/flowRateInletVelocity/flowRateInletVelocityFvPatchVectorField.H @@ -53,7 +53,7 @@ Usage Example of the boundary condition specification for a volumetric flow rate: \verbatim - myPatch + <patchName> { type flowRateInletVelocity; volumetricFlowRate 0.2; @@ -64,7 +64,7 @@ Usage Example of the boundary condition specification for a mass flow rate: \verbatim - myPatch + <patchName> { type flowRateInletVelocity; massFlowRate 0.2; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H index 3014e4cfafe..b4369b12bce 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.H @@ -56,7 +56,7 @@ Description Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fluxCorrectedVelocity; phi phi; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H index 18f02531470..258c38ceefd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestream/freestreamFvPatchField.H @@ -34,7 +34,6 @@ Description based on the sign of the flux. Usage - \table Property | Description | Required | Default value freestreamValue | freestream velocity | yes | @@ -43,7 +42,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type freestream; phi phi; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H index 56ec09a66d1..e8b5f28114b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/freestreamPressure/freestreamPressureFvPatchScalarField.H @@ -33,7 +33,6 @@ Description based on the free-stream velocity. Usage - \table Property | Description | Required | Default value U | velocity field name | no | U @@ -43,7 +42,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type freestreamPressure; } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H index 06ae68b5441..00e58e8c968 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H @@ -32,7 +32,6 @@ Description specified inflow for the case of return flow. Usage - \table Property | Description | Required | Default value phi | Flux field name | no | phi @@ -41,7 +40,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type inletOutlet; phi phi; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H index 526b50cee09..1f0b6952312 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutletTotalTemperature/inletOutletTotalTemperatureFvPatchScalarField.H @@ -33,7 +33,6 @@ Description value is applied in the case of reverse flow. Usage - \table Property | Description | Required | Default value U | velocity field name | no | U @@ -46,7 +45,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type inletOutletTotalTemperature; U U; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H index 72f2e59ff1c..2c2026545e5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H @@ -33,7 +33,6 @@ Description thr data locally. Usage - \table Property | Description | Required | Default value fieldName | name of field to be mapped | no | this field name @@ -43,7 +42,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type mappedField; fieldName T; // optional field name diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H index c3971cd4fdf..44c233b1c47 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H @@ -32,7 +32,6 @@ Description neighbour patch field to the boundary and internal values of *this. Usage - \table Property | Description | Required | Default value fieldName | name of field to be mapped | no | this field name @@ -41,7 +40,7 @@ Usage \endtable \verbatim - myPatch + <patchName> { type mappedFixedInternalValue; fieldName T; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H index 715c4043a1f..81ce8a51487 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H @@ -32,7 +32,6 @@ Description field to the boundary and internal cell values of *this. Usage - \table Property | Description | Required | Default value fieldName | name of field to be mapped | no | this field name @@ -42,7 +41,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type mappedFixedPushedInternalValue; fieldName T; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H index c3d83898c26..15257430f25 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H @@ -35,7 +35,6 @@ Description mappedPatchBase class. Usage - \table Property | Description | Required | Default value fieldName | name of field to be mapped | no | this field name @@ -46,7 +45,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type mapped; fieldName T; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H index a45d98218a0..99629b0fc4e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFlowRate/mappedFlowRateFvPatchVectorField.H @@ -38,7 +38,6 @@ Description velocity when applying the mass basis. Usage - \table Property | Description | Required | Default value phi | flux field name | no | phi @@ -48,7 +47,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type mappedFlowRate; phi phi; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H index ffe67be23ba..52b16328c7d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H @@ -32,7 +32,6 @@ Description to this patch Usage - \table Property | Description | Required | Default value phi | flux field name | no | phi @@ -40,7 +39,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type mappedVelocityFlux; phi phi; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H index 67f97dd20ee..ca21c16a475 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/movingWallVelocity/movingWallVelocityFvPatchVectorField.H @@ -33,10 +33,9 @@ Description for moving reference frame (MRF) calculations. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type movingWallVelocity; value uniform (0 0 0); // Initial value diff --git a/src/finiteVolume/fields/fvPatchFields/derived/noSlip/noSlipFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/noSlip/noSlipFvPatchVectorField.H index 329b62da4cd..b3670f4c869 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/noSlip/noSlipFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/noSlip/noSlipFvPatchVectorField.H @@ -31,10 +31,9 @@ Description This boundary condition fixes the velocity to zero at walls. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type noSlip; } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H index 5de54e9f1c1..fe653214b19 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletInlet/outletInletFvPatchField.H @@ -32,7 +32,6 @@ Description specified outflow for the case of reverse flow. Usage - \table Property | Description | Required | Default value phi | Flux field name | no | phi @@ -41,7 +40,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type outletInlet; phi phi; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H index 65169d8eda7..c777ff623a4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H @@ -33,7 +33,6 @@ Description field over this patch. Usage - \table Property | Description | Required | Default value outletPatchName | name of outlet patch | yes | @@ -42,7 +41,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type outletMappedUniformInlet; outletPatchName aPatch; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/outletPhaseMeanVelocity/outletPhaseMeanVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/outletPhaseMeanVelocity/outletPhaseMeanVelocityFvPatchVectorField.H index 7a1fd6c58cd..bafe0205543 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/outletPhaseMeanVelocity/outletPhaseMeanVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/outletPhaseMeanVelocity/outletPhaseMeanVelocityFvPatchVectorField.H @@ -44,7 +44,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type outletPhaseMeanVelocity; Umean 1.2; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H index e74b0f6bdb0..52170caa29a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/partialSlip/partialSlipFvPatchField.H @@ -32,7 +32,6 @@ Description slip is controlled by a user-supplied field. Usage - \table Property | Description | Required | Default value valueFraction | fraction od value used for boundary [0-1] | yes | @@ -40,7 +39,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type partialSlip; valueFraction uniform 0.1; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H index 6eb0855234d..8d32b05ec52 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/phaseHydrostaticPressure/phaseHydrostaticPressureFvPatchScalarField.H @@ -49,7 +49,6 @@ Description - 0: apply a zero-gradient condition Usage - \table Property | Description | Required | Default value phaseFraction | phase-fraction field name | no | alpha @@ -60,7 +59,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type phaseHydrostaticPressure; phaseFraction alpha1; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/plenumPressure/plenumPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/plenumPressure/plenumPressureFvPatchScalarField.H index 200c130f178..489c379432a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/plenumPressure/plenumPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/plenumPressure/plenumPressureFvPatchScalarField.H @@ -64,7 +64,6 @@ Description \endverbatim Usage - \table Property | Description | Required | Default value gamma | ratio of specific heats | yes | none @@ -84,7 +83,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type plenumPressure; gamma 1.4; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H index d52c186d28c..60d0c0563ab 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletOutletVelocity/pressureDirectedInletOutletVelocityFvPatchVectorField.H @@ -34,7 +34,6 @@ Description is obtained from the flux with the specified inlet direction. Usage - \table Property | Description | Required | Default value phi | flux field name | no | phi @@ -44,7 +43,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type pressureDirectedInletOutletVelocity; phi phi; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H index 96c3a7afcff..45bd87e611b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureDirectedInletVelocity/pressureDirectedInletVelocityFvPatchVectorField.H @@ -33,7 +33,6 @@ Description the specified inlet direction" direction. Usage - \table Property | Description | Required | Default value phi | flux field name | no | phi @@ -43,7 +42,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type pressureDirectedInletVelocity; phi phi; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H index 67ffcd0ca4f..bb1b79783b6 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletParSlipVelocity/pressureInletOutletParSlipVelocityFvPatchVectorField.H @@ -36,7 +36,6 @@ Description A slip condition is applied tangential to the patch. Usage - \table Property | Description | Required | Default value phi | flux field name | no | phi @@ -45,7 +44,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type pressureInletOutletParSlipVelocity; value uniform 0; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H index 997e610053c..6ca9107e9bd 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletOutletVelocity/pressureInletOutletVelocityFvPatchVectorField.H @@ -36,7 +36,6 @@ Description The tangential patch velocity can be optionally specified. Usage - \table Property | Description | Required | Default value phi | flux field name | no | phi @@ -45,7 +44,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type pressureInletOutletVelocity; phi phi; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H index ade86de9945..03f01e6e171 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletUniformVelocity/pressureInletUniformVelocityFvPatchVectorField.H @@ -34,10 +34,9 @@ Description normal to the patch faces. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type pressureInletUniformVelocity; value uniform 0; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H index 4253b2ad50c..4c024ef33f4 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureInletVelocity/pressureInletVelocityFvPatchVectorField.H @@ -33,10 +33,9 @@ Description a direction normal to the patch faces. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type pressureInletVelocity; phi phi; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H index 52766d7121f..2877c792a57 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/pressureNormalInletOutletVelocity/pressureNormalInletOutletVelocityFvPatchVectorField.H @@ -34,7 +34,6 @@ Description the flux with a direction normal to the patch faces. Usage - \table Property | Description | Required | Default value phi | flux field name | no | phi @@ -43,7 +42,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type pressureNormalInletOutletVelocity; phi phi; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/prghPressure/prghPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/prghPressure/prghPressureFvPatchScalarField.H index 2c54638a8bd..69d45ffc2a7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/prghPressure/prghPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/prghPressure/prghPressureFvPatchScalarField.H @@ -46,7 +46,6 @@ Description \endtable Usage - \table Property | Description | Required | Default value rho | rho field name | no | rho @@ -55,7 +54,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type prghPressure; rho rho; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/prghTotalHydrostaticPressure/prghTotalHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/prghTotalHydrostaticPressure/prghTotalHydrostaticPressureFvPatchScalarField.H index 64901c8c087..de4d2ec4859 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/prghTotalHydrostaticPressure/prghTotalHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/prghTotalHydrostaticPressure/prghTotalHydrostaticPressureFvPatchScalarField.H @@ -46,7 +46,6 @@ Description \endtable Usage - \table Property | Description | Required | Default value U | Velocity field name | no | U @@ -58,7 +57,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type prghTotalHydrostaticPressure; value uniform 0; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/prghTotalPressure/prghTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/prghTotalPressure/prghTotalPressureFvPatchScalarField.H index 138e941601b..a284712178d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/prghTotalPressure/prghTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/prghTotalPressure/prghTotalPressureFvPatchScalarField.H @@ -48,7 +48,6 @@ Description \endtable Usage - \table Property | Description | Required | Default value U | Velocity field name | no | U @@ -59,7 +58,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type prghTotalPressure; p0 uniform 0; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H index 0ff40f8756c..ddb6cc5df4e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingPressureInletOutletVelocity/rotatingPressureInletOutletVelocityFvPatchVectorField.H @@ -34,7 +34,6 @@ Description from the flux with a direction normal to the patch faces. Usage - \table Property | Description | Required | Default value phi | flux field name | no | phi @@ -44,7 +43,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type rotatingPressureInletOutletVelocity; phi phi; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H index f1486e113dd..800df11260e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingTotalPressure/rotatingTotalPressureFvPatchScalarField.H @@ -32,7 +32,6 @@ Description in a rotating frame. Usage - \table Property | Description | Required | Default value U | velocity field name | no | U @@ -46,7 +45,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type rotatingTotalPressure; U U; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H index 9d5c2ff9f97..485a417bda5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/rotatingWallVelocity/rotatingWallVelocityFvPatchVectorField.H @@ -31,7 +31,6 @@ Description This boundary condition provides a rotational velocity condition. Usage - \table Property | Description | Required | Default value origin | origin of rotation in Cartesian co-ordinates | yes| @@ -41,7 +40,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type rotatingWallVelocity; origin (0 0 0); diff --git a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H index 011ee44879f..0e8382ff52e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/slip/slipFvPatchField.H @@ -31,10 +31,9 @@ Description This boundary condition provides a slip constraint. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type slip; } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H index b10856aa4f7..54d0e92a699 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/supersonicFreestream/supersonicFreestreamFvPatchVectorField.H @@ -37,7 +37,6 @@ Description the domain. Usage - \table Property | Description | Required | Default value T | Temperature field name | no | T @@ -51,7 +50,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type supersonicFreestream; UInf 500; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H index 935eceb5790..23e6b199523 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H @@ -32,7 +32,6 @@ Description by its magnitude. Usage - \table Property | Description | Required | Default value refValue | reference value | yes | @@ -40,7 +39,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type surfaceNormalFixedValue; refValue uniform -10; // 10 INTO the domain diff --git a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H index 16d750f1bae..1bbc14668e7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/swirlFlowRateInletVelocity/swirlFlowRateInletVelocityFvPatchVectorField.H @@ -38,7 +38,6 @@ Description velocity when applying the mass basis. Usage - \table Property | Description | Required | Default value phi | flux field name | no | phi @@ -49,7 +48,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type swirlFlowRateInletVelocity; flowRate constant 0.2; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H index 1695a1e32f9..d7e456895c9 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/syringePressure/syringePressureFvPatchScalarField.H @@ -38,7 +38,6 @@ Description expansion/compression. Usage - \table Property | Description | Required | Default value Ap | syringe piston area [m2] | yes | @@ -55,7 +54,7 @@ Usage Example of the BC specification: \verbatim - myPatch + <patchName> { type syringePressure; Ap 1.388e-6; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H index 2ea101c4829..3b399931710 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/timeVaryingMappedFixedValueFvPatchField.H @@ -44,7 +44,6 @@ Description Values are interpolated linearly between times. Usage - \table Property | Description | Required | Default value setAverage | flag to activate setting of average value | yes | @@ -55,7 +54,7 @@ Usage \endtable \verbatim - myPatch + <patchName> { type timeVaryingMappedFixedValue; setAverage false; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H index 4cbc84763ff..bdbf00aa17e 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalPressure/totalPressureFvPatchScalarField.H @@ -91,7 +91,6 @@ Description Usage - \table Property | Description | Required | Default value U | Velocity field name | no | U @@ -104,7 +103,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type totalPressure; p0 uniform 1e5; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H index 0abbcee5f6d..236056ff3e3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/totalTemperature/totalTemperatureFvPatchScalarField.H @@ -31,7 +31,6 @@ Description This boundary condition provides a total temperature condition. Usage - \table Property | Description | Required | Default value U | Velocity field name | no | U @@ -43,7 +42,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type totalTemperature; T0 uniform 300; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H index 2302c84f30f..d0d003f055c 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H @@ -32,7 +32,6 @@ Description motion on walls. Usage - \table Property | Description | Required | Default value U | translational velocity | yes | @@ -40,7 +39,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type translatingWallVelocity; U (100 0 0); diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H index 585be2d45b9..8df95c85cef 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H @@ -47,7 +47,6 @@ Description \endvartable Usage - \table Property | Description | Required | Default value fluctuationScale | RMS fluctuation scale (fraction of mean) | yes | @@ -57,7 +56,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type turbulentInlet; fluctuationScale 0.1; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H index 79977bd7c98..36123904b63 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.H @@ -47,7 +47,6 @@ Description In the event of reverse flow, a zero-gradient condition is applied. Usage - \table Property | Description | Required | Default value intensity | fraction of mean field [0-1] | yes | @@ -57,7 +56,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type turbulentIntensityKineticEnergyInlet; intensity 0.05; // 5% turbulence diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H index 23e4363fd2e..fb61f2f0143 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformDensityHydrostaticPressure/uniformDensityHydrostaticPressureFvPatchScalarField.H @@ -45,7 +45,6 @@ Description \endtable Usage - \table Property | Description | Required | Default value rho | uniform density [kg/m3] | yes | @@ -55,7 +54,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type uniformDensityHydrostaticPressure; rho rho; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H index 9566a0601b6..94f36f5ff7b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedGradient/uniformFixedGradientFvPatchField.H @@ -31,7 +31,6 @@ Description This boundary condition provides a uniform fixed gradient condition. Usage - \table Property | Description | Required | Default value uniformGradient | uniform gradient | yes | @@ -39,7 +38,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type uniformFixedGradient; uniformGradient constant 0.2; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H index 6e6fd3e49ee..36f3972980b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformFixedValue/uniformFixedValueFvPatchField.H @@ -31,7 +31,6 @@ Description This boundary condition provides a uniform fixed value condition. Usage - \table Property | Description | Required | Default value uniformValue | uniform value | yes | @@ -39,7 +38,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type uniformFixedValue; uniformValue constant 0.2; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H index d1f3eab9dc4..bf1fa94d6e5 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformInletOutlet/uniformInletOutletFvPatchField.H @@ -31,7 +31,6 @@ Description Variant of inletOutlet boundary condition with uniform inletValue. Usage - \table Property | Description | Required | Default value phi | flux field name | no | phi @@ -40,7 +39,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type uniformInletOutlet; phi phi; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H index 5cc5e726aac..a072af378b9 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H @@ -33,7 +33,6 @@ Description value across the patch. Usage - \table Property | Description | Required | Default value patchType | underlying patch type should be \c cyclic| yes | @@ -42,7 +41,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type uniformJump; patchType cyclic; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H index c0497cbea55..5e6bdd2064f 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H @@ -33,7 +33,6 @@ Description value across the patch. Usage - \table Property | Description | Required | Default value patchType | underlying patch type should be \c cyclicAMI| yes | @@ -42,7 +41,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type uniformJumpAMI; patchType cyclicAMI; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H index a4f15cfe928..adfc012d7b3 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/uniformTotalPressure/uniformTotalPressureFvPatchScalarField.H @@ -32,7 +32,6 @@ Description pressure boundary condition Foam::totalPressureFvPatchField. Usage - \table Property | Description | Required | Default value U | Velocity field name | no | U @@ -45,7 +44,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type uniformTotalPressure; p0 uniform 1e5; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H index 000302bf7e2..edd786fcbcf 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRate/variableHeightFlowRateFvPatchField.H @@ -42,7 +42,6 @@ Description - apply a fixed value condition, with a uniform level of the lower bound Usage - \table Property | Description | Required | Default value phi | flux field name | no | phi @@ -52,7 +51,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type variableHeightFlowRate; lowerBound 0.0; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H index 425a1919312..14ecb86df92 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/variableHeightFlowRateInletVelocity/variableHeightFlowRateInletVelocityFvPatchVectorField.H @@ -35,7 +35,6 @@ Description face of the patch and alpha is ensured to be bound between 0 and 1. Usage - \table Property | Description | Required | Default value flowRate | volumetric flow rate [m3/s] | yes | @@ -44,7 +43,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type variableHeightFlowRateInletVelocity; flowRate 0.2; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H index 94747192734..ef8214ee36a 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveSurfacePressure/waveSurfacePressureFvPatchScalarField.H @@ -45,7 +45,6 @@ Description local volumetric flux. Usage - \table Property | Description | Required | Default value phi | flux field name | no | phi @@ -55,7 +54,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type waveSurfacePressure; phi phi; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H index 7758f60915f..e2e6a6c9604 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/waveTransmissive/waveTransmissiveFvPatchField.H @@ -48,7 +48,6 @@ Description \endvartable Usage - \table Property | Description | Required | Default value phi | flux field name | no | phi @@ -59,7 +58,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type waveTransmissive; phi phi; diff --git a/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H b/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H index 3edb64e6e91..9b1e4674e32 100644 --- a/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H +++ b/src/functionObjects/lagrangian/cloudInfo/cloudInfo.H @@ -50,7 +50,6 @@ Description Usage - \table Property | Description | Required | Default value type | type name: cloudInfo | yes | diff --git a/src/fvMotionSolver/pointPatchFields/derived/uniformInterpolatedDisplacement/uniformInterpolatedDisplacementPointPatchVectorField.H b/src/fvMotionSolver/pointPatchFields/derived/uniformInterpolatedDisplacement/uniformInterpolatedDisplacementPointPatchVectorField.H index 6de5f6a5ff6..9ec4cea6572 100644 --- a/src/fvMotionSolver/pointPatchFields/derived/uniformInterpolatedDisplacement/uniformInterpolatedDisplacementPointPatchVectorField.H +++ b/src/fvMotionSolver/pointPatchFields/derived/uniformInterpolatedDisplacement/uniformInterpolatedDisplacementPointPatchVectorField.H @@ -30,7 +30,6 @@ Description Motion specified as pointVectorFields. Usage - Example: \verbatim walls diff --git a/src/fvOptions/sources/derived/actuationDiskSource/actuationDiskSource.H b/src/fvOptions/sources/derived/actuationDiskSource/actuationDiskSource.H index 66e1d2ae04f..0411e6e81ab 100644 --- a/src/fvOptions/sources/derived/actuationDiskSource/actuationDiskSource.H +++ b/src/fvOptions/sources/derived/actuationDiskSource/actuationDiskSource.H @@ -45,7 +45,6 @@ Description \endvartable Usage - Example usage: \verbatim actuationDiskSourceCoeffs diff --git a/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H b/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H index 1c90a97384f..b46506ff711 100644 --- a/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H +++ b/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H @@ -60,7 +60,6 @@ Description \endvartable Usage - Example usage: \verbatim effectivenessHeatExchangerSource1 diff --git a/src/fvOptions/sources/derived/explicitPorositySource/explicitPorositySource.H b/src/fvOptions/sources/derived/explicitPorositySource/explicitPorositySource.H index bb391ab6fe6..6bbb32b3565 100644 --- a/src/fvOptions/sources/derived/explicitPorositySource/explicitPorositySource.H +++ b/src/fvOptions/sources/derived/explicitPorositySource/explicitPorositySource.H @@ -28,7 +28,6 @@ Description Explicit porosity source Usage - Example usage, here employing the Darcy-Forchheimer model: \verbatim explicitPorositySourceCoeffs diff --git a/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H b/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H index 107a24b1c90..8fbcc2002a8 100644 --- a/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H +++ b/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H @@ -51,7 +51,6 @@ Description \f] Usage - Example usage: \verbatim actuationDiskSourceCoeffs diff --git a/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H b/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H index 87c6673a8c6..1135d5c611f 100644 --- a/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H +++ b/src/fvOptions/sources/derived/rotorDiskSource/rotorDiskSource.H @@ -31,7 +31,6 @@ Description rotor forces on a cylindrical region within the domain. Usage - Example usage: \verbatim rotorDiskSourceCoeffs diff --git a/src/fvOptions/sources/derived/tabulatedAccelerationSource/tabulatedAccelerationSource.H b/src/fvOptions/sources/derived/tabulatedAccelerationSource/tabulatedAccelerationSource.H index b1ad441c418..8fa6ace2474 100644 --- a/src/fvOptions/sources/derived/tabulatedAccelerationSource/tabulatedAccelerationSource.H +++ b/src/fvOptions/sources/derived/tabulatedAccelerationSource/tabulatedAccelerationSource.H @@ -28,7 +28,6 @@ Description Solid-body 6-DoF acceleration source Usage - Example usage: \verbatim SBM diff --git a/src/fvOptions/sources/general/codedSource/CodedSource.H b/src/fvOptions/sources/general/codedSource/CodedSource.H index f09acc6ecb8..b484e91587b 100644 --- a/src/fvOptions/sources/general/codedSource/CodedSource.H +++ b/src/fvOptions/sources/general/codedSource/CodedSource.H @@ -51,7 +51,6 @@ Description eqn is the fvMatrix Usage - Example usage in controlDict: \verbatim energySource diff --git a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H index 2e068ccf4e9..096bea60da5 100644 --- a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H +++ b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H @@ -35,7 +35,7 @@ Description Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type filmPyrolysisTemperatureCoupled; phi phi; // name of flux field (default = phi) diff --git a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H index df19b8fbdd5..c907431cdc0 100644 --- a/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H +++ b/src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H @@ -36,7 +36,7 @@ Description Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type filmPyrolysisVelocityCoupled; phi phi; // name of flux field (default = phi) diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H index 33f2404f41b..8c08e37f90a 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H @@ -48,7 +48,6 @@ Description \endvartable Usage - \table Property | Description | Required | Default value phi | Flux field name | no | phi @@ -58,7 +57,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type filmHeightInletVelocity; phi phi; diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H index 34089629aa7..fafc5ee650d 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H @@ -34,7 +34,6 @@ Description mass released from the film model. Usage - \table Property | Description | Required | Default value B | model coefficient | no | 5.5 @@ -46,7 +45,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type alphatFilmWallFunction; B 5.5; diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.H index a26f42095a5..f25479b88cc 100644 --- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.H +++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.H @@ -33,10 +33,9 @@ Description surface film models. Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type nutkFilmWallFunction; value uniform 0; diff --git a/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H b/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H index be080f831db..0bb7a092ced 100644 --- a/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H +++ b/src/regionModels/thermalBaffleModels/derivedFvPatchFields/thermalBaffle/thermalBaffleFvPatchScalarField.H @@ -46,7 +46,7 @@ Description Usage Example of the boundary condition specification: \verbatim - myPatch_master + <masterPatchName> { type compressible::thermalBaffle; @@ -103,7 +103,6 @@ Usage scatterModel none; } - // Extrude model for new region extrudeModel linearNormal; @@ -120,7 +119,7 @@ Usage Slave patch on primary region: \verbatim - myPatch_slave + <slavePatchName> { type compressible::thermalBaffle; kappa fluidThermo; @@ -128,7 +127,6 @@ Usage value uniform 300; \endverbatim - Patches on baffle region: \verbatim bottom @@ -148,7 +146,6 @@ Usage } \endverbatim - See also Foam::compressible::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField Foam::regionModels::thermalBaffleModels::thermalBaffleModel diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H index 593cf50117c..537ca8cdaa6 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/fixedEnergy/fixedEnergyFvPatchScalarField.H @@ -31,10 +31,9 @@ Description This boundary condition provides a fixed condition for internal energy Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type fixedEnergy; value uniform 100; diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H index a2f83f01d4a..0b0c78adfe1 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H @@ -46,10 +46,9 @@ Description \endvartable Usage - Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type gradientEnergy; gradient uniform 10; diff --git a/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H b/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H index f4bac96319b..7b31185dfb2 100644 --- a/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H +++ b/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiation/MarshakRadiationFvPatchScalarField.H @@ -35,7 +35,6 @@ Description user specified temperature field name. Usage - \table Property | Description | Required | Default value T | temperature field name | no | T @@ -43,7 +42,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type MarshakRadiation; T T; diff --git a/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H b/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H index c1a19844296..d2c114a1559 100644 --- a/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H +++ b/src/thermophysicalModels/radiation/derivedFvPatchFields/MarshakRadiationFixedTemperature/MarshakRadiationFixedTemperatureFvPatchScalarField.H @@ -35,7 +35,6 @@ Description using the \c Trad entry. Usage - \table Property | Description | Required | Default value T | temperature field name | no | T @@ -43,7 +42,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type MarshakRadiationFixedTemperature; Trad uniform 1000; // radiation temperature field diff --git a/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H index 03ab4829b53..e84f45bdc3e 100644 --- a/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.H @@ -34,7 +34,6 @@ Description temperature field boundary condition. Usage - \table Property | Description | Required | Default value T | temperature field name | no | T @@ -43,7 +42,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type greyDiffusiveRadiation; T T; diff --git a/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H b/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H index 85da20c9e93..7a5085c9518 100644 --- a/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H +++ b/src/thermophysicalModels/radiation/derivedFvPatchFields/greyDiffusiveViewFactor/greyDiffusiveViewFactorFixedValueFvPatchScalarField.H @@ -32,7 +32,6 @@ Description heat flux, \c Qr, for use with the view factor model Usage - \table Property | Description | Required | Default value Qro | external radiative heat flux | yes | @@ -41,7 +40,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type greyDiffusiveRadiationViewFactor; Qro uniform 0; diff --git a/src/thermophysicalModels/radiation/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H b/src/thermophysicalModels/radiation/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H index f1a6905d40b..0137f56e139 100644 --- a/src/thermophysicalModels/radiation/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H +++ b/src/thermophysicalModels/radiation/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.H @@ -32,7 +32,6 @@ Description condition, where the patch temperature is specified. Usage - \table Property | Description | Required | Default value T | temperature field name | no | T @@ -40,7 +39,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type wideBandDiffusiveRadiation; value uniform 0; diff --git a/src/transportModels/twoPhaseProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H b/src/transportModels/twoPhaseProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H index d1af35cd78d..e52eab3eb4b 100644 --- a/src/transportModels/twoPhaseProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H +++ b/src/transportModels/twoPhaseProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H @@ -46,7 +46,7 @@ Description the wall e.g.: \verbatim - myPatch + <patchName> { type alphaContactAngle; limit none; diff --git a/src/transportModels/twoPhaseProperties/alphaContactAngle/temperatureDependentAlphaContactAngle/temperatureDependentAlphaContactAngleFvPatchScalarField.H b/src/transportModels/twoPhaseProperties/alphaContactAngle/temperatureDependentAlphaContactAngle/temperatureDependentAlphaContactAngleFvPatchScalarField.H index fa45c25ecc1..df08b538191 100644 --- a/src/transportModels/twoPhaseProperties/alphaContactAngle/temperatureDependentAlphaContactAngle/temperatureDependentAlphaContactAngleFvPatchScalarField.H +++ b/src/transportModels/twoPhaseProperties/alphaContactAngle/temperatureDependentAlphaContactAngle/temperatureDependentAlphaContactAngleFvPatchScalarField.H @@ -28,7 +28,6 @@ Description Temperature-dependent constant alphaContactAngle scalar boundary condition. Usage - \table Property | Description | Required | Default value T | Temperature field name | no | T @@ -37,7 +36,7 @@ Usage Example of the boundary condition specification: \verbatim - myPatch + <patchName> { type temperatureDependentAlphaContactAngle; theta0 constant 60; diff --git a/src/triSurface/triSurface/interfaces/AC3D/writeAC.C b/src/triSurface/triSurface/interfaces/AC3D/writeAC.C index edddefab2a3..a8239eae303 100644 --- a/src/triSurface/triSurface/interfaces/AC3D/writeAC.C +++ b/src/triSurface/triSurface/interfaces/AC3D/writeAC.C @@ -52,16 +52,16 @@ void Foam::triSurface::writeAC(Ostream& os) const labelList faceMap; - surfacePatchList myPatches(calcPatches(faceMap)); + surfacePatchList patches(calcPatches(faceMap)); // Write header. Define materials. os << "AC3Db" << endl; - forAll(myPatches, patchi) + forAll(patches, patchi) { - const word& pName = myPatches[patchi].name(); + const word& pName = patches[patchi].name(); label colourI = patchi % 8; label colourCompI = 3 * colourI; @@ -75,16 +75,16 @@ void Foam::triSurface::writeAC(Ostream& os) const } os << "OBJECT world" << endl - << "kids " << myPatches.size() << endl; + << "kids " << patches.size() << endl; // Write patch points & faces. label faceIndex = 0; - forAll(myPatches, patchi) + forAll(patches, patchi) { - const surfacePatch& sp = myPatches[patchi]; + const surfacePatch& sp = patches[patchi]; os << "OBJECT poly" << endl << "name \"" << sp.name() << '"' << endl; diff --git a/src/triSurface/triSurface/interfaces/DX/writeDX.C b/src/triSurface/triSurface/interfaces/DX/writeDX.C index 668a3a8acf8..9e28c0f5cbb 100644 --- a/src/triSurface/triSurface/interfaces/DX/writeDX.C +++ b/src/triSurface/triSurface/interfaces/DX/writeDX.C @@ -44,14 +44,14 @@ void triSurface::writeDXGeometry ) const { labelList faceMap; - surfacePatchList myPatches(calcPatches(faceMap)); + surfacePatchList patches(calcPatches(faceMap)); // Print patch names as comment os << "# Patches:" << endl; - forAll(myPatches, patchi) + forAll(patches, patchi) { os << "# " << patchi << " " - << myPatches[patchi].name() << endl; + << patches[patchi].name() << endl; } os << nl << endl; @@ -75,14 +75,14 @@ void triSurface::writeDXGeometry { label faceIndex = 0; - forAll(myPatches, patchi) + forAll(patches, patchi) { // Print all faces belonging to this patch for ( label patchFacei = 0; - patchFacei < myPatches[patchi].size(); + patchFacei < patches[patchi].size(); patchFacei++ ) { @@ -132,11 +132,11 @@ void triSurface::writeDX(const bool writeSorted, Ostream& os) const // Write patch number as data labelList faceMap; - surfacePatchList myPatches(calcPatches(faceMap)); + surfacePatchList patches(calcPatches(faceMap)); - forAll(myPatches, patchi) + forAll(patches, patchi) { - forAll(myPatches[patchi], patchFacei) + forAll(patches[patchi], patchFacei) { os << patchi << endl; } diff --git a/src/triSurface/triSurface/interfaces/GTS/writeGTS.C b/src/triSurface/triSurface/interfaces/GTS/writeGTS.C index 6b8f3b0deb9..d2d70282f20 100644 --- a/src/triSurface/triSurface/interfaces/GTS/writeGTS.C +++ b/src/triSurface/triSurface/interfaces/GTS/writeGTS.C @@ -40,13 +40,13 @@ void triSurface::writeGTS(const bool writeSorted, Ostream& os) const labelList faceMap; - surfacePatchList myPatches(calcPatches(faceMap)); + surfacePatchList patches(calcPatches(faceMap)); // Print patch names as comment - forAll(myPatches, patchi) + forAll(patches, patchi) { os << "# " << patchi << " " - << myPatches[patchi].name() << endl; + << patches[patchi].name() << endl; } os << "#" << endl; @@ -82,12 +82,12 @@ void triSurface::writeGTS(const bool writeSorted, Ostream& os) const if (writeSorted) { label faceIndex = 0; - forAll(myPatches, patchi) + forAll(patches, patchi) { for ( label patchFacei = 0; - patchFacei < myPatches[patchi].size(); + patchFacei < patches[patchi].size(); patchFacei++ ) { diff --git a/src/triSurface/triSurface/interfaces/OBJ/writeOBJ.C b/src/triSurface/triSurface/interfaces/OBJ/writeOBJ.C index 1111e8b1488..40abdae6a0f 100644 --- a/src/triSurface/triSurface/interfaces/OBJ/writeOBJ.C +++ b/src/triSurface/triSurface/interfaces/OBJ/writeOBJ.C @@ -45,15 +45,15 @@ void triSurface::writeOBJ(const bool writeSorted, Ostream& os) const labelList faceMap; - surfacePatchList myPatches(calcPatches(faceMap)); + surfacePatchList patches(calcPatches(faceMap)); const pointField& ps = points(); // Print patch names as comment - forAll(myPatches, patchi) + forAll(patches, patchi) { os << "# " << patchi << " " - << myPatches[patchi].name() << nl; + << patches[patchi].name() << nl; } os << "#" << nl; @@ -75,16 +75,16 @@ void triSurface::writeOBJ(const bool writeSorted, Ostream& os) const { label faceIndex = 0; - forAll(myPatches, patchi) + forAll(patches, patchi) { // Print all faces belonging to this patch - os << "g " << myPatches[patchi].name() << nl; + os << "g " << patches[patchi].name() << nl; for ( label patchFacei = 0; - patchFacei < myPatches[patchi].size(); + patchFacei < patches[patchi].size(); patchFacei++ ) { @@ -103,11 +103,11 @@ void triSurface::writeOBJ(const bool writeSorted, Ostream& os) const { // Get patch (=compact region) per face labelList patchIDs(size()); - forAll(myPatches, patchi) + forAll(patches, patchi) { - label facei = myPatches[patchi].start(); + label facei = patches[patchi].start(); - forAll(myPatches[patchi], i) + forAll(patches[patchi], i) { patchIDs[faceMap[facei++]] = patchi; } @@ -121,7 +121,7 @@ void triSurface::writeOBJ(const bool writeSorted, Ostream& os) const if (prevPatchi != patchIDs[facei]) { prevPatchi = patchIDs[facei]; - os << "g " << myPatches[patchIDs[facei]].name() << nl; + os << "g " << patches[patchIDs[facei]].name() << nl; } os << "f " << operator[](facei)[0] + 1 << ' ' diff --git a/src/triSurface/triSurface/interfaces/OFF/writeOFF.C b/src/triSurface/triSurface/interfaces/OFF/writeOFF.C index 686e6357c2d..838ee47606f 100644 --- a/src/triSurface/triSurface/interfaces/OFF/writeOFF.C +++ b/src/triSurface/triSurface/interfaces/OFF/writeOFF.C @@ -40,13 +40,13 @@ void triSurface::writeOFF(const bool writeSorted, Ostream& os) const << "# Regions:" << endl; labelList faceMap; - surfacePatchList myPatches(calcPatches(faceMap)); + surfacePatchList patches(calcPatches(faceMap)); // Print patch names as comment - forAll(myPatches, patchi) + forAll(patches, patchi) { os << "# " << patchi << " " - << myPatches[patchi].name() << endl; + << patches[patchi].name() << endl; } os << nl << endl; @@ -72,14 +72,14 @@ void triSurface::writeOFF(const bool writeSorted, Ostream& os) const { label faceIndex = 0; - forAll(myPatches, patchi) + forAll(patches, patchi) { // Print all faces belonging to this patch for ( label patchFacei = 0; - patchFacei < myPatches[patchi].size(); + patchFacei < patches[patchi].size(); patchFacei++ ) { diff --git a/src/triSurface/triSurface/interfaces/SMESH/writeSMESH.C b/src/triSurface/triSurface/interfaces/SMESH/writeSMESH.C index 8651f55d05c..46627f7e1b3 100644 --- a/src/triSurface/triSurface/interfaces/SMESH/writeSMESH.C +++ b/src/triSurface/triSurface/interfaces/SMESH/writeSMESH.C @@ -53,20 +53,20 @@ void triSurface::writeSMESH(const bool writeSorted, Ostream& os) const { labelList faceMap; - surfacePatchList myPatches(calcPatches(faceMap)); + surfacePatchList patches(calcPatches(faceMap)); os << size() << " 1" << endl; // 1 attribute: region number label faceIndex = 0; - forAll(myPatches, patchi) + forAll(patches, patchi) { // Print all faces belonging to this patch for ( label patchFacei = 0; - patchFacei < myPatches[patchi].size(); + patchFacei < patches[patchi].size(); patchFacei++ ) { diff --git a/src/triSurface/triSurface/interfaces/STL/writeSTL.C b/src/triSurface/triSurface/interfaces/STL/writeSTL.C index bb74d31cd0f..ffa4eb826ad 100644 --- a/src/triSurface/triSurface/interfaces/STL/writeSTL.C +++ b/src/triSurface/triSurface/interfaces/STL/writeSTL.C @@ -35,15 +35,15 @@ void Foam::triSurface::writeSTLASCII(const bool writeSorted, Ostream& os) const { labelList faceMap; - surfacePatchList myPatches(calcPatches(faceMap)); + surfacePatchList patches(calcPatches(faceMap)); if (writeSorted) { label faceIndex = 0; - forAll(myPatches, patchi) + forAll(patches, patchi) { // Print all faces belonging to this region - const surfacePatch& patch = myPatches[patchi]; + const surfacePatch& patch = patches[patchi]; os << "solid " << patch.name() << endl; @@ -84,11 +84,11 @@ void Foam::triSurface::writeSTLASCII(const bool writeSorted, Ostream& os) const { // Get patch (=compact region) per face labelList patchIDs(size()); - forAll(myPatches, patchi) + forAll(patches, patchi) { - label facei = myPatches[patchi].start(); + label facei = patches[patchi].start(); - forAll(myPatches[patchi], i) + forAll(patches[patchi], i) { patchIDs[faceMap[facei++]] = patchi; } @@ -103,11 +103,11 @@ void Foam::triSurface::writeSTLASCII(const bool writeSorted, Ostream& os) const if (currentPatchi != -1) { // Have already valid patch. Close it. - os << "endsolid " << myPatches[currentPatchi].name() + os << "endsolid " << patches[currentPatchi].name() << nl; } currentPatchi = patchIDs[facei]; - os << "solid " << myPatches[currentPatchi].name() << nl; + os << "solid " << patches[currentPatchi].name() << nl; } const vector& n = faceNormals()[facei]; @@ -133,7 +133,7 @@ void Foam::triSurface::writeSTLASCII(const bool writeSorted, Ostream& os) const if (currentPatchi != -1) { - os << "endsolid " << myPatches[currentPatchi].name() + os << "endsolid " << patches[currentPatchi].name() << nl; } } diff --git a/src/triSurface/triSurface/interfaces/TRI/writeTRI.C b/src/triSurface/triSurface/interfaces/TRI/writeTRI.C index 0050463cf3f..fbf421145fd 100644 --- a/src/triSurface/triSurface/interfaces/TRI/writeTRI.C +++ b/src/triSurface/triSurface/interfaces/TRI/writeTRI.C @@ -41,18 +41,18 @@ void triSurface::writeTRI(const bool writeSorted, Ostream& os) const labelList faceMap; - surfacePatchList myPatches(calcPatches(faceMap)); + surfacePatchList patches(calcPatches(faceMap)); if (writeSorted) { label faceIndex = 0; - forAll(myPatches, patchi) + forAll(patches, patchi) { for ( label patchFacei = 0; - patchFacei < myPatches[patchi].size(); + patchFacei < patches[patchi].size(); patchFacei++ ) { diff --git a/src/triSurface/triSurface/interfaces/VTK/writeVTK.C b/src/triSurface/triSurface/interfaces/VTK/writeVTK.C index 33bc7de5566..41e33ea0c5d 100644 --- a/src/triSurface/triSurface/interfaces/VTK/writeVTK.C +++ b/src/triSurface/triSurface/interfaces/VTK/writeVTK.C @@ -65,20 +65,20 @@ void triSurface::writeVTK(const bool writeSorted, Ostream& os) const os << "POLYGONS " << size() << ' ' << 4*size() << nl; labelList faceMap; - surfacePatchList myPatches(calcPatches(faceMap)); + surfacePatchList patches(calcPatches(faceMap)); if (writeSorted) { label faceIndex = 0; - forAll(myPatches, patchi) + forAll(patches, patchi) { // Print all faces belonging to this patch for ( label patchFacei = 0; - patchFacei < myPatches[patchi].size(); + patchFacei < patches[patchi].size(); patchFacei++ ) { @@ -110,12 +110,12 @@ void triSurface::writeVTK(const bool writeSorted, Ostream& os) const faceIndex = 0; - forAll(myPatches, patchi) + forAll(patches, patchi) { for ( label patchFacei = 0; - patchFacei < myPatches[patchi].size(); + patchFacei < patches[patchi].size(); patchFacei++ ) { -- GitLab