From b44f84ad39b20c89520e78927c37a6d83dde43d2 Mon Sep 17 00:00:00 2001
From: andy <andy>
Date: Fri, 13 Jul 2012 16:17:48 +0100
Subject: [PATCH] ENH: Further updates to doxygen docs
---
src/OpenFOAM/global/foamDoc.H | 3 +-
.../SRFFreestreamVelocityFvPatchVectorField.H | 29 +++++++-----
.../SRFVelocityFvPatchVectorField.H | 26 ++++++----
.../inletOutlet/inletOutletFvPatchField.H | 8 ++--
.../oscillatingFixedValueFvPatchField.H | 4 +-
.../fvPatchFields/doc/boundaryConditions.dox | 30 ++++++++++++
.../fvPatchFields/doc/fvPatchFieldDoc.H | 15 +++++-
.../functionObjects/doc/functionObjects.dox | 1 +
.../mappedVariableThicknessWallFvPatch.H | 3 ++
.../doc/surfaceFilmBoundaryConditionsDoc.H | 32 +++++++++++++
...ilmHeightInletVelocityFvPatchVectorField.H | 47 +++++++++++++------
...alphatFilmWallFunctionFvPatchScalarField.H | 44 ++++++++++++-----
.../mutkFilmWallFunctionFvPatchScalarField.H | 26 ++++++++--
.../doc/thermoBaffleBoundaryConditionsDoc.H | 32 +++++++++++++
...emperatureThermoBaffleFvPatchScalarField.H | 9 +++-
.../compressibleRASBoundaryConditionsDoc.H | 0
.../incompressibleRASBoundaryConditionsDoc.H | 0
17 files changed, 245 insertions(+), 64 deletions(-)
create mode 100644 src/regionModels/surfaceFilmModels/derivedFvPatchFields/doc/surfaceFilmBoundaryConditionsDoc.H
create mode 100644 src/regionModels/thermoBaffleModels/derivedFvPatchFields/doc/thermoBaffleBoundaryConditionsDoc.H
rename src/turbulenceModels/compressible/RAS/derivedFvPatchFields/{ => doc}/compressibleRASBoundaryConditionsDoc.H (100%)
rename src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/{ => doc}/incompressibleRASBoundaryConditionsDoc.H (100%)
diff --git a/src/OpenFOAM/global/foamDoc.H b/src/OpenFOAM/global/foamDoc.H
index 27389e27a0b..cd3f1998a5a 100644
--- a/src/OpenFOAM/global/foamDoc.H
+++ b/src/OpenFOAM/global/foamDoc.H
@@ -36,6 +36,7 @@ License
turbulence and heat transfer, to solid dynamics and electromagnetics.
<a href="http://www.openfoam.org/features">More ...</a>
+
\section layout Code Layout
The OpenFOAM source code comprises of four main components:
@@ -53,11 +54,11 @@ License
- doc:
supporting documentation
+
\section usingTheCode Using the code
- \subpage pagePostProcessing
- \subpage pageBoundaryConditions
- - \subpage grpIcoRASBoundaryConditions
\*---------------------------------------------------------------------------*/
diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H
index e29d0a0864c..b51f472c718 100644
--- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H
@@ -33,24 +33,29 @@ Description
determine the local velocity using:
\f[
- Up = cos(theta)*UInf + sin(theta)*(n^UInf) - Up_srf
+ U_p = cos(\theta)*U_{Inf} + sin(theta) (n^UInf) - U_{p,srf}
\f]
where
- \var Up = patch velocity [m/s]
- \var UInf = free stream velocity in the absolute frame [m/s]
- \var theta = swept angle [rad]
- \var n = axis direction of the SRF
- \var Up_srf = SRF velocity of the patch
+ /vartable
+ U_p = patch velocity [m/s]
+ U_{Inf} = free stream velocity in the absolute frame [m/s]
+ theta = swept angle [rad]
+ n = axis direction of the SRF
+ U_{p,srf} = SRF velocity of the patch
+ /endvartable
+
+
+ /heading Patch usage
Example of the boundary condition specification:
\verbatim
- myPatch
- {
- type SRFFreestreamVelocity;
- UInf (0 0 0); // free stream velocity
- value uniform (0 0 0); // optional value entry
- }
+ myPatch
+ {
+ type SRFFreestreamVelocity;
+ UInf (0 0 0); // free stream velocity
+ value uniform (0 0 0); // optional value entry
+ }
\endverbatim
SourceFiles
diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H
index 376f8ae27ea..890744bc414 100644
--- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H
+++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H
@@ -24,6 +24,9 @@ License
Class
Foam::SRFVelocityFvPatchVectorField
+Group
+ grpInletBoundaryConditions grpWallBoundaryConditions
+
Description
Velocity condition to be used in conjunction with the single
rotating frame (SRF) model (see: SRFModel class)
@@ -35,29 +38,34 @@ Description
The optional \c relative flag switches the behaviour of the patch
such that:
- \li relative = yes: inlet velocity applied 'as is':
+ - relative = yes: inlet velocity applied 'as is':
\f[
Up = U_in
\f]
- \li relative = no : SRF velocity is subtracted from the inlet velocity:
+ - relative = no : SRF velocity is subtracted from the inlet velocity:
\f[
Up = U_in - U_srf
\f]
+ /heading Patch usage
+
Example of the boundary condition specification:
\verbatim
- myPatch
- {
- type SRFVelocity;
- relative yes; // relative motion to the SRF?
- inletValue uniform (0 0 0); // inlet velocity
- value uniform (0 0 0); // initial value
- }
+ myPatch
+ {
+ type SRFVelocity;
+ relative yes; // relative motion to the SRF?
+ inletValue uniform (0 0 0); // inlet velocity
+ value uniform (0 0 0); // initial value
+ }
\endverbatim
+SeeAlso
+ Foam::fixedValueFvPatchField
+
SourceFiles
SRFVelocityFvPatchVectorField.C
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H
index b5b7fcf492f..449f4e86318 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H
@@ -36,7 +36,7 @@ Description
/table
Property | Description | Required | Default value
phi | flux field name | no | phi
- inletValue | inlet value | yes |
+ inletValue | inlet value for reverse flow | yes |
/endtable
Example of the boundary condition specification:
@@ -44,9 +44,9 @@ Description
myPatch
{
type inletOutlet;
- phi phi; // name of flux field (default = phi)
- inletValue uniform 0; // reverse flow (inlet) value
- value uniform 0; // initial value
+ phi phi;
+ inletValue uniform 0;
+ value uniform 0;
}
\endverbatim
diff --git a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H
index d42c23f5ddf..e134124954d 100644
--- a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H
+++ b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H
@@ -32,7 +32,7 @@ Description
amplitude and frequency.
/f[
- x_p = (1 + a.sin(\pi f t))x_{ref} + x_o
+ x_p = (1 + a sin(\pi f t))x_{ref} + x_o
/f]
where
@@ -58,7 +58,7 @@ Description
Example of the boundary condition specification:
\verbatim
- inlet
+ myPatch
{
type oscillatingFixedValue;
refValue uniform 5.0;
diff --git a/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox
index b8787fe010d..d89698dc9ad 100644
--- a/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox
+++ b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox
@@ -55,4 +55,34 @@ Wall functions for compressible flow
- \ref grpCmpWallFunctions
+\section secBoundaryConditions Typical usage for pressure-velocity systems
+
+subsonic inlet (flow specified):
+/table
+ Variable | Symbol | Type
+ pressure | p | \link Foam::zeroGradientFvPatchField zeroGradient\endlink
+ velocity | U | \link Foam::fixedValueFvPatchField fixedValue\endlink
+ transported property | - | \link Foam::fixedValueFvPatchField fixedValue\endlink
+ derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink
+/endtable
+
+subsonic outlet:
+/table
+ Variable | Symbol | Type
+ pressure | p | \link Foam::fixedValueFvPatchField fixedValue\endlink
+ velocity | U | \link Foam::inletOutletFvPatchField inletOutlet\endlink or \link Foam::pressureInletOutletVelocityFvPatchVectorField pressureInletOutletVelocity\endlink
+ transported property | - | \link Foam::inletOutletFvPatchField inletOutlet\endlink
+ derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink
+/endtable
+
+wall:
+/table
+ Variable | Symbol | Type
+ pressure | p | \link Foam::zeroGradientFvPatchField zeroGradient\endlink
+ velocity | U | \link Foam::fixedValueFvPatchField fixedValue\endlink
+ transported property | - | \link Foam::fixedValueFvPatchField fixedValue\endlink
+ derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink
+/endtable
+
+
\*---------------------------------------------------------------------------*/
diff --git a/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H b/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H
index e4461605f6a..4cd593a213a 100644
--- a/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H
+++ b/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H
@@ -25,13 +25,24 @@ License
\defgroup grpBoundaryConditions Boundary Conditions
@{
- This group contains OpenFOAM boundary condition types
+ This group contains OpenFOAM boundary condition types. All conditions
+ are derived from the base Foam::fvPatchField class. Patch values are
+ typically updated using the virtual functions
+ - Foam::fvPatchField::updateCoeffs()
+ - Foam::fvPatchField::evaluate()
+
+ The difference between the methods is based on when the patch values are
+ updated. When the condition is applied to a solution variable, the
+ call to updateCoeffs() occurs as a preliminary step of the
+ \<matrix\>.solve(). The evaluate() method is invoked after, or idependent
+ of the matrix solve, via a call to \<field\>.correctBoundaryConditions().
@}
\defgroup grpConstraintBoundaryConditions Constraint boundary Conditions
@{
\ingroup grpBoundaryConditions
- This group contains constraint boundary condition types
+ This group contains constraint boundary condition types. These conditions
+ are mainly employed to reduced dimensioned cases.
@}
\defgroup grpInletBoundaryConditions Inlet boundary Conditions
diff --git a/src/postProcessing/functionObjects/doc/functionObjects.dox b/src/postProcessing/functionObjects/doc/functionObjects.dox
index ee4355a6566..d6ae8946854 100644
--- a/src/postProcessing/functionObjects/doc/functionObjects.dox
+++ b/src/postProcessing/functionObjects/doc/functionObjects.dox
@@ -51,6 +51,7 @@ functions
{
type functionObjectType;
libs ("libMyFunctionObjectlib.so");
+ active yes; // active by default
outputControl outputTime; // output or timeStep
outputInterval 1; // only necessary for outputControl=timeStep
...
diff --git a/src/regionModels/regionModel/derivedFvPatches/mappedVariableThicknessWall/mappedVariableThicknessWallFvPatch.H b/src/regionModels/regionModel/derivedFvPatches/mappedVariableThicknessWall/mappedVariableThicknessWallFvPatch.H
index a203fc01696..f4709bb62e6 100644
--- a/src/regionModels/regionModel/derivedFvPatches/mappedVariableThicknessWall/mappedVariableThicknessWallFvPatch.H
+++ b/src/regionModels/regionModel/derivedFvPatches/mappedVariableThicknessWall/mappedVariableThicknessWallFvPatch.H
@@ -24,6 +24,9 @@ License
Class
Foam::mappedVariableThicknessWallFvPatch
+Group
+ grpRegionBoundaryConditions
+
Description
Take thickness field and number of layers and returns deltaCoeffs
as 2.0/thickness/nLayers.
diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/doc/surfaceFilmBoundaryConditionsDoc.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/doc/surfaceFilmBoundaryConditionsDoc.H
new file mode 100644
index 00000000000..600a85bf2dc
--- /dev/null
+++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/doc/surfaceFilmBoundaryConditionsDoc.H
@@ -0,0 +1,32 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+License
+ This file is part of OpenFOAM.
+
+ OpenFOAM is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free
+ Software Foundation, either version 3 of the License, or (at your option)
+ any later version.
+
+ OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
+ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ details.
+
+ You should have received a copy of the GNU General Public License along with
+ OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+\defgroup grpSurfaceFilmBoundaryConditions Surface film boundary conditions
+@{
+ \ingroup grpRegionBoundaryConditions
+ This group contains surface film model boundary conditions
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H
index 571b597204d..16e7e0db1fb 100644
--- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H
+++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H
@@ -24,6 +24,9 @@ License
Class
Foam::filmHeightInletVelocityFvPatchVectorField
+Group
+ grpSurfaceFilmBoundaryConditions
+
Description
This boundary condition is designed to be used in conjunction with
surface film modelling. It provides a velocity inlet boundary condition
@@ -31,29 +34,43 @@ Description
obtained from the flux with a direction normal to the patch faces using:
\f[
- Up = \frac{n*phi}{rho*mag(Sf)*delta}
+ U_p = \frac{n \phi}{\rho |Sf| \delta}
\f]
where
- \var Up = patch velocity [m/s]
- \var n = patch normal vector
- \var phi = mass flux [kg/s]
- \var rho = density [kg/m3]
- \var Sf = patch face area vectors [m2]
- \var delta = film height [m]
+ /vartable
+ U_p | patch velocity [m/s]
+ n | patch normal vector
+ \phi | mass flux [kg/s]
+ \rho | density [kg/m3]
+ Sf | patch face area vectors [m2]
+ \delta | film height [m]
+ /endvartable
+
+ /heading Patch usage
+
+ /table
+ Property | Description | Required | Default value
+ phi | Flux field name | no | phi
+ rho | density field name | no | rho
+ deltaf | height field name | no | deltaf
+ /endtable
Example of the boundary condition specification:
\verbatim
- myPatch
- {
- type filmHeightInletVelocity;
- phi phi; // name of flux field (default = phi)
- rho rho; // name of density field (default = rho)
- deltaf deltaf; // name of height field (default = deltaf)
- value uniform (0 0 0); // initial velocity / [m/s]
- }
+ myPatch
+ {
+ type filmHeightInletVelocity;
+ phi phi;
+ rho rho;
+ deltaf deltaf;
+ value uniform (0 0 0); // initial velocity / [m/s]
+ }
\endverbatim
+SeeAlso
+ Foam::fixedValueFvPatchField
+
SourceFiles
filmHeightInletVelocityFvPatchVectorField.C
diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H
index e01028532ad..fd8ef900414 100644
--- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H
+++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H
@@ -24,25 +24,43 @@ License
Class
Foam::compressible::RASModels::alphatFilmWallFunctionFvPatchScalarField
+Group
+ grpSurfaceFilmBoundaryConditions grpCmpWallFunctions
+
Description
- Turbulent thermal diffusivity boundary condition for use with surface
- film models. This condition varies from the standard wall function by
- taking into account any mass released from the film model.
+ This boundary condition provides a turbulent thermal diffusivity condition
+ when using wall functions, for use with surface film models. This
+ condition varies from the standard wall function by taking into account any
+ mass released from the film model.
+
+ /heading Patch usage
+
+ /table
+ Property | Description | Required | Default value
+ B | model coefficient | no | 5.5
+ yPlusCrit | critical y+ for transition to turbulent flow | no|11.05
+ Cmu | model coefficient | no | 0.09
+ kappa | Von-Karman constant | no | 0.41
+ Prt | turbulent Prandtl number | no | 0.85
+ /endtable
Example of the boundary condition specification:
\verbatim
- myPatch
- {
- type alphatFilmWallFunction;
- B 5.5; // B coefficient (default = 5.5)
- yPlusCrit 11.05; // critical y+ (default = 11.05)
- Cmu 0.09; // Cmu coefficient (default = 0.09)
- kappa 0.41; // kappa coefficient (default = 0.41)
- Prt 0.85; // turbulent Prandtl number (default = 0.85)
- value uniform 0; // optional value entry
- }
+ myPatch
+ {
+ type alphatFilmWallFunction;
+ B 5.5;
+ yPlusCrit 11.05;
+ Cmu 0.09;
+ kappa 0.41;
+ Prt 0.85;
+ value uniform 0;
+ }
\endverbatim
+SeeAlso
+ Foam::fixedValueFvPatchField
+
SourceFiles
alphatFilmWallFunctionFvPatchScalarField.C
diff --git a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H
index aab054effb7..1370214146f 100644
--- a/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H
+++ b/src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/mutkFilmWallFunction/mutkFilmWallFunctionFvPatchScalarField.H
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
- \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
+ \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@@ -22,11 +22,29 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
- Foam::compressible::RASModels::
- mutkFilmWallFunctionFvPatchScalarField
+ Foam::compressible::RASModels::mutkFilmWallFunctionFvPatchScalarField
+
+Group
+ grpSurfaceFilmBoundaryConditions grpCmpWallFunctions
Description
- Wall function boundary condition for use with surface film models.
+ This boundary condition provides a turbulent viscosity condition when
+ using wall functions, based on turbulence kinetic energy, for use with
+ surface film models.
+
+ /heading Patch usage
+
+ Example of the boundary condition specification:
+ \verbatim
+ myPatch
+ {
+ type mutkFilmWallFunction;
+ value uniform 0;
+ }
+ \endverbatim
+
+SeeAlso
+ Foam::mutkWallFunctionFvPatchScalarField
SourceFiles
mutkFilmWallFunctionFvPatchScalarField.C
diff --git a/src/regionModels/thermoBaffleModels/derivedFvPatchFields/doc/thermoBaffleBoundaryConditionsDoc.H b/src/regionModels/thermoBaffleModels/derivedFvPatchFields/doc/thermoBaffleBoundaryConditionsDoc.H
new file mode 100644
index 00000000000..ac1553d1040
--- /dev/null
+++ b/src/regionModels/thermoBaffleModels/derivedFvPatchFields/doc/thermoBaffleBoundaryConditionsDoc.H
@@ -0,0 +1,32 @@
+/*---------------------------------------------------------------------------*\
+ ========= |
+ \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
+ \\ / O peration |
+ \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation
+ \\/ M anipulation |
+-------------------------------------------------------------------------------
+License
+ This file is part of OpenFOAM.
+
+ OpenFOAM is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free
+ Software Foundation, either version 3 of the License, or (at your option)
+ any later version.
+
+ OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY
+ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ details.
+
+ You should have received a copy of the GNU General Public License along with
+ OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+\defgroup grpThermoBoundaryConditions Thermo baffle boundary conditions
+@{
+ \ingroup grpRegionBoundaryConditions
+ This group contains thermo baffle model boundary conditions
+@}
+
+\*---------------------------------------------------------------------------*/
diff --git a/src/regionModels/thermoBaffleModels/derivedFvPatchFields/temperatureThermoBaffle/temperatureThermoBaffleFvPatchScalarField.H b/src/regionModels/thermoBaffleModels/derivedFvPatchFields/temperatureThermoBaffle/temperatureThermoBaffleFvPatchScalarField.H
index 82392d123e6..cc1ee4bd9ed 100644
--- a/src/regionModels/thermoBaffleModels/derivedFvPatchFields/temperatureThermoBaffle/temperatureThermoBaffleFvPatchScalarField.H
+++ b/src/regionModels/thermoBaffleModels/derivedFvPatchFields/temperatureThermoBaffle/temperatureThermoBaffleFvPatchScalarField.H
@@ -24,9 +24,12 @@ License
Class
Foam::temperatureThermoBaffleFvPatchScalarField
+Group
+ grpThermoBoundaryConditions
+
Description
- Thermal boundary applied to both sides:the baffle region and
- in the primary region.
+ This boundary condition provides a coupled condition between the primary
+ baffle mesh regions.
The primary region creates it and evolves the thermal baffle heat transfer
equation.
@@ -95,6 +98,8 @@ Description
value uniform 300;
+SeeAlso
+ Foam::turbulentTemperatureCoupledBaffleMixedFvPatchScalarField
SourceFiles
temperatureThermoBaffleFvPatchScalarField.C
diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/compressibleRASBoundaryConditionsDoc.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/doc/compressibleRASBoundaryConditionsDoc.H
similarity index 100%
rename from src/turbulenceModels/compressible/RAS/derivedFvPatchFields/compressibleRASBoundaryConditionsDoc.H
rename to src/turbulenceModels/compressible/RAS/derivedFvPatchFields/doc/compressibleRASBoundaryConditionsDoc.H
diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/incompressibleRASBoundaryConditionsDoc.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/doc/incompressibleRASBoundaryConditionsDoc.H
similarity index 100%
rename from src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/incompressibleRASBoundaryConditionsDoc.H
rename to src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/doc/incompressibleRASBoundaryConditionsDoc.H
--
GitLab