diff --git a/applications/solvers/compressible/rhoCentralFoam/BCs/rho/fixedRhoFvPatchScalarField.H b/applications/solvers/compressible/rhoCentralFoam/BCs/rho/fixedRhoFvPatchScalarField.H index 5779d86b922cd232e3fd20706673b01345853c6d..0e2e83eb749598e3a70296a415e21cb26aafd529 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 bdf3153c33b6578b689ee5b51b35cf1c4ef8490c..8b0e39b88239e71fd870b06966aaab022799fa2d 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 fa25fa6fc77be4283957340c0f890dad4cee2641..43e42c4361ff74d87fbf78129f5cb196b28c78bc 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 1727dc016fba41698c9246f2233fc85063518358..c878d68d9d43bbbfa07d1766002108c8179bc5b6 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 fa407cce12e556f63b4cead08512cc6b78c69bdb..2405cac9daafc2b665b79d9aa414b5eecc5196c3 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 90eba83b1ec38a21102c64f4315f853ede469667..3a3b61fb3ac1d19fe763fddbea8be1de40cd1057 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 ad63aa6526a848c9458cb0bd4fb540e493dc2472..0fd335ea88f52b54df1102d4c1ef6d8c4f07cf3a 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 0caa3cb406e60dd69dac3b00530a803b71c80a0e..a01786738a1cea05026fd21770d1c2e7db247aab 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 ac3464e1b99693095755f263c79d41abbe969172..23dedf0b07b4ea04b8985fe4632bc53efd776aeb 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 5a9d914e066605525d13e31a9d3af8120ca30bb6..c164c41ce3d5bcb0d0e4e31b915571f308df100f 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 7c6fb3ac2b9464f6d25ddacedea39dfe652dd24f..2a5afaaf8ca44cf17243b6dfe01f027ab0b02323 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 6c9413dcd407efefc5f010d994065dc502d3e11b..e15a24047eeb8215f61edcfb0bb8fc308edb2437 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 f932003f727c7771a4251e28181cd16b622b5d23..392ec0fd0ba7f8a5ed83786d18ba153d8aa25c84 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 d937a1f2ef5a8392d6bc577f84750f464914d0ef..ca4c35bc5d531675c6440a4f5144d0103b8e1eb4 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 d6a9d443e353b46afc88a957bf1858608cee2341..ec12b1d57a8f4c8463b55054582441c190a146e2 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 1b718f983c1e8124eec60d6bb684434853432be4..5af8fe5f839984240b2d872becef0f4e34672adb 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 1ce35ddf4295de8b78c21219a8c3cbf3fe7c3205..8fddacb2213d04cddd8befbf7f91e34b7e93abb4 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 eaf7aa8a4e0de3a8266a6e794f1c56a7aea33843..d71c85ea81055201ffd1ea239baa55f0446d0d8d 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 9d2cc294e130d1564912783a37a63accbfd73c7e..9ee1dfac1a9e556f67a6f2e4779017172c289e4f 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 b14f4a41051ada1474310df109106fe240288fb9..db5c43a1404c383225071af14921da7f11283b2e 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 21c5f12db59ef81b1ef1d79a574eba4c2b149cb4..af62657f8a86c4f857eb1aa3420717e87654405e 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 d77dadc3e77abf210fea66b4cab57898e008768a..9e8ace814a214ef27c4479d3f329f4972ddeeecc 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 5d627780139fe262951b04631b3885db802d1e94..3e6580cfd827ff86f110e15328f7031d26009299 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 02a3bd7ef4ddd7982e67fa0826655ed80d8ff070..72977684dec8ae5522ffc9391cbde5f3e13ed14f 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 1fdfe933dfb4efb75b67a70e78e3ace2cb68d0fc..006f06b170cd231d04167c25f514c7895f9c4db9 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 c1acfded6bb9cad94b7f2d6d102c581f5a35c243..5468624828ce8b921830bbb01f9e2c4b5eb4a283 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 7958e26817ab87fb5f486d9767eb195684b06c4e..b88b25212857dba51f212e7d0f31b7cf891110aa 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 dda5793e1e766c13705f8caa0e3f8629c3815052..c773014783349f2362fef3bb880c1c316dd123a9 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 477872fbf1964eef242ad7e0acebaeaeca5a433e..86cf0d4b32f2c9b5d290e37bfe31104f775e0134 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 d3fbbeb2f78c97b4ed69f25b68e9799faebc9fdb..f93ba98d3d3bd770de9bc4734d1bfd09816376c4 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 ab06f04d6c80a558985fd5b232519e28fcd14cbe..56b73e2241ce10c0f3d17daac8d77235fae4c3fc 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 2704c4c97f9b4ed800c6cd3e96325dad5f051e28..a96dfb7ae0f883716dc45cd7f46d484df28c90af 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 99983355081e5ab454aa531aa5c8c8194dc9e849..1eba8523ce4428a2616dffd1224da14bec5b4f17 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 5247fd7b2b210feb968e6b7f5502d677276e8af8..fab8f67b42628d224e4ac952d29289356f77d5d3 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 51ec6bb5372eed557b331fef9261d30da3e69824..83b25df36ad3bd97ee4cdc48789fb69607c5d5a6 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 1055a5a5d4fb549f1d7679aaf158b67e9959596d..83efeab562387f28f0537c912e1378b0396e144a 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 dabab17c64f05878e24de50b02798f000d44b3be..8560c5edfcf79efc0c4851876bae69180b740008 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 2eeae499a92e8a4ce9780c7633c0ca3849b934f0..cdf96caba799e98a5f5792d9ba596054ccfed362 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 5f967c336945ef804bf91a1936ba17ca6a25ee5a..4c3101993ee430c208dc323df4350ff7b939410e 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 ad7b3682238e3d5d3eb38338d824d845328d8868..de6ae1ac6f6553009bc6d33923797a0427373063 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 5ba454dd27d79c95b690e2336eab8698801d42f1..da998d3a85d8f833733046f676f53fdd7193ff20 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 30572201883670133984e17f4df22e0e634f23df..622a52fcdea74faf091037ef4809722286a4fdc9 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 c210f17e084c7232fd669650327d4777e1ed484a..3cf2421420dd38b7ed47d6b09235fef02bd8c301 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 b51e69adcc60b39d7cf806761638d9a59fbafdc6..1da39dc1989effaf956151cb864497d8e0be948d 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 049e1f86fc1e8284718a8a0d50aaace31a1e1ddb..c8c1ec4b507e40eb67dea8f492ea6e8d9eefe81b 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 06975886b85ae55b1b4abb76bace0e1d1b9024dc..8122c21139033c7588fa72980d716285ee4665f7 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 b371c900282698ebac169a5924c829288738a855..ebb2fb8cbd2eaddafc9a31b4d8bd90d84ac5b1a8 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 ef5cdcc961d5f4b3bd9b68e0ac5be89503cce084..7ad7bddbb4019eff0e3a7b8d4c01e0e01b312915 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 57a5f7df2e226db0294057420e5330cdc4098f58..9645916cbd5d4ea2eaa91f1efe6e1f3a538bc2aa 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 017acb422c1d1fabc61df7248e50edea62e26d3c..b6b90e98a7f61a17e880bdaa52c584ee3e9a5f6a 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 ddb4c5deeac7af856701b9ade5bcb1fbaccdd9d5..bfe1b75708a0d74486ad8ee04f296eb31576b755 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 bdc81a727bc849ddaaf9c9910b03a9fef03f8a82..1f492a95cb53dd882b9b622b9de8445c478be5d1 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 8e988347d96cdd381145e988a21dcaf18d365c31..ef808b36c6bae3c6a1f92a8f6001e7158a0aaf96 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 1dfb805c6e628c45c7f2bec77a07c51a6968d606..ab6057d9dee69cc45f48b652c651e897f2bf5e82 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 d8aef9e6ef9fe3d705813a9ae6593c62a5290280..eab75d121a2b29e6acb256489d33db7264552dd5 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 b4639cf184fcff8ecb37ff7024126c911e4fc469..e720cadc79d5e28fc816e4417c77916fc8714482 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 25396f644b1a51e5538fd8ac4eca11143236691f..f645c0257f85119ee46459462d7b51ec67b862d1 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 10dfd789883dd31fdfaae7d09b31708877bf1713..e5caf978687183b07362d80d54449371490a7c94 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 9b7097b44d3d0b558513d8ff0ede50c79d5bf3cc..e8f7453d4dcb7506d8fb1580de9ac20b0bbae0e5 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 7484cbc80034a92802bc684168f8fbf8b95eb679..37b20c9c45736bc4657444ef43a8cbdb422621dd 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 1a2843d41f5d88286d851d06cebe572a0977bc44..feaf17f0c1a4c2a2c8a1dc985e2cab780fe606dc 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 b5dc098aef9a9e2cdf2abdaa8dd4be466eff88ce..190ff28e5c9882ebd86df6d291a3ceceea236155 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 2bda5a59890349d8fe706fe5807c0d2287ec9935..301db5d0d668d1c9ada4a82dc449812751484022 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 74b69ab133b144d89f4d4db881c49bcce3767eb4..aa4b19f28b81caf81d591330afa3d343ce0cd860 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 382d6b3dba39fd6add4671c0f92b261549993175..1bdaee71b8aef270a01847f932963de639984295 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 f60932280d1479fb014a8e2e32e3359d4b0784b6..aa34bf6637259bdabd22fba654e3c98c1a7b38a9 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 7870fa71269328fc519f7aa494f5424ceaa7cd62..4b1b997be5656663c79eed516fa095b9e725a02d 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 6f81586f177ac5940cb1b236ce263647fd150a07..48d8ecbde0cdf9e49b6a6709cfa6f0fbe0918e92 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 7e5ebaa86af244b8cbb8b90dce5c3161babc6564..66e892ff986c3c51311b5b3514375ae5ad7392eb 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 f3fc4d9128e94e89783e24302690d33027e3fb0f..ab356135c6e7d2681ef7d974f6b5f5831643757e 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 6ce56ecfe10abd5c73b0bf55aa7906f612159cec..95b45a82d8c46417f6ffb32895286e6da9b06f62 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 48391c4e4eb039a929fce8670a29b1b1be1d2110..93c11806223a539832127d4dd70daeb37e56b5b9 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 98d701efab7a4abc5cb77b8a319a93f398e78bbb..a13f11984324a56e68643b80806c18146360b8bf 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 15d7af290bfef2200785581760d641f68a999b8e..502be93b545c3722b914deea347753757599c95d 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 09f627ebcf446d729be62bd891e1dc2e7c7f1ac6..286004f97bfc26ecbdb15610117abd741b6695e0 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 3014e4cfafea62f8f7a2210f347f466452541c50..b4369b12bcec37538f8d0f00abb0965138e8c354 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 18f02531470d125888513ff54eabc4d2f07653fd..258c38ceefd39740b9a1f3dfaaa04e5a2dd2e24c 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 56ec09a66d1f6b1326f474e1e1d59021b0fa8432..e8b5f28114b5e155d9c44861bc5713be80652c6f 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 06ae68b54419e19fb4c118da6d1ab1df73303421..00e58e8c9680424fb8f981d90495f5fed3e9a685 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 526b50cee0925b9f369e5425d3755f75b3777194..1f0b695231290afd7bb87a7626a3368e924b493c 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 72f2e59ff1c29c5c9a7bc04e75520a0b64816aa0..2c2026545e51cb0e5036e278c00f60e6d376c372 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 c3971cd4fdf68fadb38bf8470476978edc3495ae..44c233b1c475181616ed2fef51ba3b7a2242340b 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 715c4043a1fc095275fb1f4e6393f1152bf62f43..81ce8a51487326a5c7e1020e569febe8054e2804 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 c3d83898c26bf134efce4e743f852f01c83faa66..15257430f25d6ee3c5245c87fcd15e710da16568 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 a45d98218a07909a39d184fbcd45646ae3f98485..99629b0fc4eec145fb5b8b179c10d29290dfde18 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 ffe67be23ba0c6f7a8ca0acb5a0ef840d37fe26b..52b16328c7d6690997c91ef0a992e315e7527baf 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 67f97dd20eebb48f6290902f77e93f475f46f6f1..ca21c16a47586f0e270d10d8d04625af74a5bf83 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 329b62da4cd271c0a1303f169a5725bacb07372d..b3670f4c869b0ee6b100c914efd0281a3feb2643 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 5de54e9f1c1908551f659a5fd8569e0bef5ff8dc..fe653214b191970eb47c5aad483b07faa84e7248 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 65169d8eda7e637b23245dc47b55997d8d4bcb48..c777ff623a45ed590d39b8f1c5751eb4b2a7904c 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 7a1fd6c58cd43d36702516e9638643268ce63cad..bafe02055431b29322066967aa2cf62e42b6a911 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 e74b0f6bdb0b76841d8c1e7638243071d1217f9a..52170caa29a6cdab13f452f18320b6a41066f21e 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 6eb0855234dec24d3dd5168872403413f74ab41f..8d32b05ec529a660346b28b03a5d0ef1cdb77834 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 200c130f17825bad1505c8b3cfb38e1cc2f3d775..489c379432a00d7436648530cd1277b574518edf 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 d52c186d28cb0824fd50f3b18732c9e98f657ad0..60d0c0563abd8b77cca019fa44721ced8a1ae014 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 96c3a7afcff44c97538ed56de1b7bcad0ea21166..45bd87e611b5429f904d83b810b56f54493d6cf4 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 67ffcd0ca4f5ea2f3a39de3ed3008b759594f494..bb1b79783b66c9ebad727980c25a932d618292e3 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 997e610053caa126a4a7e20984d73c077932ea8c..6ca9107e9bdf0877d96294c56c46db1ae1da1307 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 ade86de9945340c4a3080a02ef0a3f39aee72e34..03f01e6e1713a1e6c2ef7c647794f6df39de3696 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 4253b2ad50c7e0d5a637d878143ef49a12eeb3a4..4c024ef33f4d5d101893eeec88b6d4e941579cfc 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 52766d7121fbd9e7d5e700ab8e97085e34d598aa..2877c792a57bde540e067908ee6768e0acda7557 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 2c54638a8bda5e182e83c3b921430069238c221c..69d45ffc2a7fea9d6fbdf209a5ebdc636cd88805 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 64901c8c0872da91ba6eac152b3b3db9c12a8bbc..de4d2ec4859fd5bcf65ca44f5b84b981924bc6bf 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 138e941601bdf471875d8eda200a529555bc1141..a284712178d547af7dbe45caa25270718655bf35 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 0ff40f8756cde7a8f9f8874c9d34070ae67061db..ddb6cc5df4e01ee21f0f650b82b4ef07e1d385ee 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 f1486e113dddd5c2539d0ca33d8b5cf2a74bb365..800df11260e857d24d2b107bed2fcf816b533f1a 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 9d5c2ff9f97f106c43a34bddd03c86af8a6c5b7f..485a417bda5770936b57e67acb9c072bb69691ed 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 011ee44879f4795d5cf64918a6c3cbeddcacb5e3..0e8382ff52ea284790bac5ae84efb7c36315a8a3 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 b10856aa4f72ac65ca746b043674c841b603df27..54d0e92a69909664464eee2de6e75a7ef6003c36 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 935eceb5790658a3a8aa03837e290533e6284e12..23e6b1995230adfd863f63964e9bd474117e6a44 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 16d750f1baed3d9503a02e90b02f071c767e68ec..1bbc14668e7ae6a9d275df90c9cbe50c274bdd6f 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 1695a1e32f9bf6edca18200f7b71c48918319b85..d7e456895c9d99f3f6a11a9ea8c52411e60e7082 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 2ea101c4829eb093dce94162ae5f9a494dc712c1..3b39993171028d30caa3352c406e9eb72c6b6293 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 4cbc84763ff4b709c1d3a26615398d395f7b5860..bdbf00aa17e0996f66a371d41c660b8a72e95972 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 0abbcee5f6d7ecc14a7475c2f0603efd31d7b2f3..236056ff3e32495ea84451d1968d3b245c206fb0 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 2302c84f30fa7bcab274935b65366c237b8ef112..d0d003f055ce86b59d7ac6fb42433ac2094d3a58 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 585be2d45b9df1014e5eca46cd07cfeecb9beb4d..8df95c85cef66e40ee1e0df993e659572b996a61 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 79977bd7c9851ef1a0a29f8c4d40cb5b328c77d6..36123904b630bdd64903739fc7064884834be215 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 23e4363fd2e08b92d29b7d800d20ce8135597f5b..fb61f2f0143e0cf505e45192d7c8f88bc61b4103 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 9566a0601b64eac6698290796da2fcc9285b888b..94f36f5ff7b8d0b7d2101180ec95ed26e3a0bd8c 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 6e6fd3e49ee5595a76d2fad9e647676efad1d01e..36f3972980b11c82751adcccd9f1089ce25a5672 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 d1f3eab9dc43e8a22faa608d832531d173e5c1cf..bf1fa94d6e557b0e6b4f1c512afe21d187a32551 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 5cc5e726aac18577f9564e11a4a23d859c727d99..a072af378b928567eb5759a2d0d0e6cbc0feb9cc 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 c0497cbea556a3e5c1ad098f8067df1aca2fe162..5e6bdd2064f5bfed46b5a212cb4aa1937e59fc78 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 a4f15cfe928720160e23c91fc76f992b7e53f988..adfc012d7b3f9c4c464c73d9bb75ecec88a171ff 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 000302bf7e2e7702eb0d012768777d6763cf0715..edd786fcbcf58ae5b182d678c2abb8798b306d1b 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 425a19193129aa402dbf7291b92375f86e4e5f53..14ecb86df92bd891ae3d5d37b647ffaa9526ffb2 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 94747192734a2387ac9208679d13dc743d176e86..ef8214ee36a43e5019df73b988fc43f52bbf5b96 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 7758f60915f751ec64fd5cb7a68497522139dcb7..e2e6a6c96042f5f89c92322c0c0a24b8ccc35d72 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 3edb64e6e91376dda7f81bb942ec0d11622ee15b..9b1e4674e32e33740bf4cadbdeba770aa56dde8e 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 6de5f6a5ff6cb01d9e8128dbfc7bca03d6ffd81e..9ec4cea6572d06346d43dad7093aae1bb007201f 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 66e1d2ae04f1d9aae1739e9e7ef39926b7fab9df..0411e6e81abbab3d9b63a7a9817ff4a321d7ab47 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 1c90a97384fe7d17b24fce9987c500e8f322a3dc..b46506ff711008afb1649bc8fd96e7a6e5a274b2 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 bb391ab6fe643448a13e2ac481dc1993110adc36..6bbb32b3565aa3debabb51e7f357b5be598572b4 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 107a24b1c9083e8f9b96589cea3f00a2eeea784c..8fbcc2002a831f0f4d7e3e77d81348da704dafb3 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 87c6673a8c6dac9793dc6e294bbaf23613bab691..1135d5c611fb67ff83445fa3e14b500611b40191 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 b1ad441c41874ea98841b2b32f78f0bb62837e81..8fa6ace247436bc911c1adaf819287e072b761bc 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 f09acc6ecb8b10f14769c0ce18b63e427a05f9e2..b484e91587bd66bef524b085b7681042218dfa13 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 2e068ccf4e9cd217932517e051877782bf0b72fa..096bea60da5cf8374c12e8d9e58d47c8497b656a 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 df19b8fbdd50ebf55565d55d36a19ccedb1f6a62..c907431cdc087abd71cd10df9560a41fcdbc05c5 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 33f2404f41b5e17b3b378fc65872853675549b39..8c08e37f90ad2af25d4015f63cb882ca0239a046 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 34089629aa7d1e9a0f5e72226b47f5f65def2697..fafc5ee650d4570b31f73d0a9c40a5ba52bb8894 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 a26f42095a5500949653e534ee8880b3817692de..f25479b88cc27c6444f51e481fbe3d1020b74a2f 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 be080f831dbb9cea0f5e35b9bdcf553be6f86910..0bb7a092cedd9c3c6874eaf4b375324bf5ca74e6 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 593cf50117cc7b7fe1d586647be1a2fa9ba4d896..537ca8cdaa6aad112d176145ab3b9f17bd957ebc 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 a2f83f01d4a594df56fe76a5286e82a1e473325c..0b0c78adfe16441ece23ca382feabd38b8b495ac 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 f4bac96319bd55d9cf63971ee8532f27a8400494..7b31185dfb215621ecf0e350e272db6e6da03516 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 c1a198442962ec6787c0a0d2e1ecea2e3f76a85a..d2c114a15592e92603387a5324cacb010ce0a8f6 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 03ab4829b531be964ceecbb5a2f054c81dd34e47..e84f45bdc3e8fcbcf2a72e59945fa243d188d506 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 85da20c9e9352d5589a4807d2ea25ab5cb81cad9..7a5085c95180a54df392d7b861c4c14b996abd97 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 f1a6905d40b93bcd669eb466f6d88d674df90552..0137f56e139a926d53efb3276e0ed878dd458888 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 d1af35cd78d47ce5316600e6fdfa6c0553f858ea..e52eab3eb4bacc7094c986b0c2f34e8d177b1d12 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 fa45c25ecc155861e65c5e0a56a18aa5403c873a..df08b538191470e235ec816fbe624df74e7f7672 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 edddefab2a35e095aa0852c9e2a26963f547ba40..a8239eae303f624b2ff647140970134a61a094bf 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 668a3a8acf837949955da445b0ef41a633a621df..9e28c0f5cbb4cc0b23436ebe2f62f1fddc9e981a 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 6b8f3b0deb9c9fd8d59b0bfb2d8b1a6c51782cb1..d2d70282f2070579b11efd5867516f0266180b17 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 1111e8b1488e99c6474bd67e8597e971eb01497a..40abdae6a0f82f0bc10d9990a0f717bcc04b472e 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 686e6357c2d3a3e01ff9cc43e23ebddb3acc46ee..838ee47606ff631d91efe25a582a3c479f8375ca 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 8651f55d05c7602c1073eb1fbda15e667e990b33..46627f7e1b397055accdd24a2997b55873c825bf 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 bb74d31cd0fcae1ee73a9b13e5dd207e24442ed3..ffa4eb826ad3c6128d286387c4a4243c8291148a 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 0050463cf3f171db780012c439138b212627dafb..fbf421145fdefa5941569e4ebc85f10f3b85cdd3 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 33bc7de5566d5f067dae1f69f1f9e34818724be9..41e33ea0c5db5f4a733f830e2bcd7e0a2adc30ef 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++ ) {