zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: Added doxygen documentation for thermo BCs

Browse Source
This commit is contained in:
andy
2012-07-13 16:16:50 +01:00
parent e2ed990347
commit 5e86700b85
15 changed files with 265 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -27,13 +27,32 @@ License
\ref grpBoundaryConditions
\section secBoundaryConditionsOverview Overview
- \ref grpConstraintBoundaryConditions
- \ref grpInletBoundaryConditions
- \ref grpOutletBoundaryConditions
- \ref grpGenericBoundaryConditions
- \ref grpCoupledBoundaryConditions
- \ref grpWallBoundaryConditions
\subsection secBC1 Basic boundary conditions
- \ref grpConstraintBoundaryConditions
- \ref grpInletBoundaryConditions
- \ref grpOutletBoundaryConditions
- \ref grpGenericBoundaryConditions
- \ref grpCoupledBoundaryConditions
- \ref grpWallBoundaryConditions
\subsection secBC2 Turbulent flow boundary conditions
- \ref grpIcoRASBoundaryConditions
- \ref grpCmpRASBoundaryConditions
\subsection secBC3 Thermophysical boundary conditions
- \ref grpThermoBoundaryConditions
\section secWallFunctions Wall functions
Wall functions for incompressible flow
- \ref grpIcoWallFunctions
Wall functions for compressible flow
- \ref grpCmpWallFunctions
\*---------------------------------------------------------------------------*/

31
src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H Normal file
View File

@ -0,0 +1,31 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / 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 Thermophysical boundary conditions
@{
This group contains thermophysical model boundary conditions
@}
\*---------------------------------------------------------------------------*/

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

@ -24,7 +24,31 @@ License
Class
Foam::energyJumpFvPatchScalarField
Group
grpThermoBoundaryConditions grpCoupledBoundaryConditions
Description
This boundary condition provides an energy jump condition across a pair
of coupled patches.
/heading Patch usage
/table
Property | Description | Required | Default value
jump | energy jump values | yes |
/endtable
Example of the boundary condition specification:
\verbatim
myPatch
{
type energyJump;
jump uniform 100;
}
\endverbatim
SeeAlso
Foam::fixedJumpFvPatchField
SourceFiles
energyJumpFvPatchScalarField.C
@ -43,7 +67,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
Class energyJumpFvPatchScalarField Declaration
Class energyJumpFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/
class energyJumpFvPatchScalarField
@ -120,7 +144,6 @@ public:
// Member functions
// Evaluation functions
//- Update the coefficients

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

@ -24,8 +24,25 @@ License
Class
Foam::fixedEnergyFvPatchScalarField
Group
grpThermoBoundaryConditions
Description
A fixed boundary condition for internal energy
This boundary condition provides a fixed condition for internal energy
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type fixedEnergy;
value uniform 100;
}
\endverbatim
SeeAlso
Foam::fixedValueFvPatchField
SourceFiles
fixedEnergyFvPatchScalarField.C
@ -43,7 +60,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
Class fixedEnergyFvPatchScalarField Declaration
Class fixedEnergyFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/
class fixedEnergyFvPatchScalarField

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

@ -22,10 +22,26 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::gradientInternalEnergyFvPatchScalarField
Foam::gradientEnergyFvPatchScalarField
Group
grpThermoBoundaryConditions
Description
Gradient boundary condition for internal energy
This boundary condition provides a gradient condition for internal energy
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type gradientEnergy;
gradient uniform 10;
}
\endverbatim
SeeAlso
Foam::fixedGradientFvPatchField
SourceFiles
gradientEnergyFvPatchScalarField.C
@ -43,7 +59,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
Class gradientEnergyFvPatchScalarField Declaration
Class gradientEnergyFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/
class gradientEnergyFvPatchScalarField

10
src/thermophysicalModels/basic/derivedFvPatchFields/mixedEnergy/mixedEnergyFvPatchScalarField.H
View File

@ -24,8 +24,14 @@ License
Class
Foam::mixedEnergyFvPatchScalarField
Group
grpThermoBoundaryConditions
Description
Mixed boundary conditions for internal energy
This boundary condition provides a mixed condition for internal energy
SeeAlso
Foam::mixedFvPatchField
SourceFiles
mixedEnergyFvPatchScalarField.C
@ -43,7 +49,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
Class mixedEnergyFvPatchScalarField Declaration
Class mixedEnergyFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/
class mixedEnergyFvPatchScalarField

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

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -24,8 +24,30 @@ License
Class
Foam::wallHeatTransferFvPatchScalarField
Group
grpThermoBoundaryConditions grpWallBoundaryConditions
Description
Enthalpy boundary conditions for wall heat transfer
This boundary condition provides an enthalpy condition for wall heat
transfer
/heading Patch usage
/table
Property | Description | Required | Default value
Tinf | wall temperature | yes |
alphaWall | thermal diffusivity | yes |
/endtable
Example of the boundary condition specification:
\verbatim
myPatch
{
type wallHeatTransfer;
Tif uniform 500;
alphaWall uniform 1;
}
\endverbatim
SourceFiles
wallHeatTransferFvPatchScalarField.C
@ -43,7 +65,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
Class wallHeatTransferFvPatch Declaration
Class wallHeatTransferFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/
class wallHeatTransferFvPatchScalarField
@ -52,10 +74,10 @@ class wallHeatTransferFvPatchScalarField
{
// Private data
//- Tinf
//- Temperature at the wall
scalarField Tinf_;
//- alphaWall
//- Thermal diffusivity at the wall
scalarField alphaWall_;

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

@ -40,7 +40,7 @@ Foam::MarshakRadiationFvPatchScalarField::MarshakRadiationFvPatchScalarField
:
mixedFvPatchScalarField(p, iF),
radiationCoupledBase(p, "undefined", scalarField::null()),
TName_("undefined")
TName_("T")
{
refValue() = 0.0;
refGrad() = 0.0;
@ -76,7 +76,7 @@ Foam::MarshakRadiationFvPatchScalarField::MarshakRadiationFvPatchScalarField
:
mixedFvPatchScalarField(p, iF),
radiationCoupledBase(p, dict),
TName_(dict.lookup("T"))
TName_(dict.lookupOrDefault<word>("T", "T"))
{
if (dict.found("value"))
{
@ -191,7 +191,7 @@ void Foam::MarshakRadiationFvPatchScalarField::write(Ostream& os) const
{
mixedFvPatchScalarField::write(os);
radiationCoupledBase::write(os);
os.writeKeyword("T") << TName_ << token::END_STATEMENT << nl;
writeEntryIfDifferent<word>(os, "T", "T", TName_);
}

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

@ -24,6 +24,9 @@ License
Class
Foam::MarshakRadiationFvPatchScalarField
Group
grpThermoBoundaryConditions
Description
A 'mixed' boundary condition that implements a Marshak condition for the
incident radiation field (usually written as G)
@ -31,16 +34,27 @@ Description
The radiation temperature is retrieved from the mesh database, using a
user specified temperature field name.
/heading Patch usage
/table
Property | Description | Required | Default value
T | temperature field name | no | T
/endtable
Example of the boundary condition specification:
\verbatim
myPatch
{
type MarshakRadiation;
T T; // name of temperature field
value uniform 0; // optional value entry
}
myPatch
{
type MarshakRadiation;
T T;
value uniform 0;
}
\endverbatim
SeeAlso
Foam::radiationCoupledBase
Foam::mixedFvPatchField
SourceFiles
MarshakRadiationFvPatchScalarField.C

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

@ -24,6 +24,9 @@ License
Class
Foam::MarshakRadiationFixedTemperatureFvPatchScalarField
Group
grpThermoBoundaryConditions
Description
A 'mixed' boundary condition that implements a Marshak condition for the
incident radiation field (usually written as G)
@ -31,16 +34,27 @@ Description
The radiation temperature field across the patch is supplied by the user
using the \c Trad entry.
/heading Patch usage
/table
Property | Description | Required | Default value
T | temperature field name | no | T
/endtable
Example of the boundary condition specification:
\verbatim
myPatch
{
type MarshakRadiationFixedT;
Trad uniform 1000; // radiation temperature field
value uniform 0; // place holder
}
myPatch
{
type MarshakRadiationFixedTemperature;
Trad uniform 1000; // radiation temperature field
value uniform 0; // place holder
}
\endverbatim
SeeAlso
Foam::radiationCoupledBase
Foam::mixedFvPatchField
SourceFiles
MarshakRadiationFixedTemperatureFvPatchScalarField.C

8
src/thermophysicalModels/radiationModels/derivedFvPatchFields/greyDiffusiveRadiation/greyDiffusiveRadiationMixedFvPatchScalarField.C
View File

@ -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
@ -45,7 +45,7 @@ greyDiffusiveRadiationMixedFvPatchScalarField
:
mixedFvPatchScalarField(p, iF),
radiationCoupledBase(p, "undefined", scalarField::null()),
TName_("undefinedT")
TName_("T")
{
refValue() = 0.0;
refGrad() = 0.0;
@ -83,7 +83,7 @@ greyDiffusiveRadiationMixedFvPatchScalarField
:
mixedFvPatchScalarField(p, iF),
radiationCoupledBase(p, dict),
TName_(dict.lookup("T"))
TName_(dict.lookupOrDefault<word>("T", "T"))
{
if (dict.found("refValue"))
{
@ -262,7 +262,7 @@ void Foam::radiation::greyDiffusiveRadiationMixedFvPatchScalarField::write
{
mixedFvPatchScalarField::write(os);
radiationCoupledBase::write(os);
os.writeKeyword("T") << TName_ << token::END_STATEMENT << nl;
writeEntryIfDifferent<word>(os, "T", "T", TName_);
}

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

@ -22,7 +22,10 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::greyDiffusiveRadiationMixedFvPatchScalarField
Foam::radiation::greyDiffusiveRadiationMixedFvPatchScalarField
Group
grpThermoBoundaryConditions
Description
This boundary condition provides a grey-diffuse condition for radiation
@ -30,15 +33,23 @@ Description
(fvDOM), in which the radiation temperature is retrieved from the
temperature field boundary condition.
/heading Patch usage
/table
Property | Description | Required | Default value
T | temperature field name | no | T
emissivityMode | emissivity mode: solidThermo or lookup | yes |
/endtable
Example of the boundary condition specification:
\verbatim
myPatch
{
type greyDiffusiveRadiation;
T T; // name of temperature field
emissivityMode solidThermo; // solidThermo | lookup
value uniform 0; // initial value
}
myPatch
{
type greyDiffusiveRadiation;
T T;
emissivityMode solidThermo;
value uniform 0;
}
\endverbatim
SeeAlso

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

@ -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,21 +22,32 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::greyDiffusiveViewFactorFixedValueFvPatchScalarField
Foam::radiation::greyDiffusiveViewFactorFixedValueFvPatchScalarField
Group
grpThermoBoundaryConditions
Description
This boundary condition provides a grey-diffuse condition for radiative
heat flux, \c Qr, for use with the view factor model
/heading Patch usage
/table
Property | Description | Required | Default value
Qro | external radiative heat flux | yes |
emissivityMode | emissivity mode: solidThermo or lookup | yes |
/endtable
Example of the boundary condition specification:
\verbatim
myPatch
{
type greyDiffusiveRadiationViewFactor;
Qro uniform 0; // external radiative heat flux
emissivityMode solidThermo; // solidThermo | lookup
value uniform 0; // initial value
}
myPatch
{
type greyDiffusiveRadiationViewFactor;
Qro uniform 0;
emissivityMode solidThermo;
value uniform 0;
}
\endverbatim
SeeAlso

7
src/thermophysicalModels/radiationModels/derivedFvPatchFields/wideBandDiffusiveRadiation/wideBandDiffusiveRadiationMixedFvPatchScalarField.C
View File

@ -46,7 +46,7 @@ wideBandDiffusiveRadiationMixedFvPatchScalarField
:
mixedFvPatchScalarField(p, iF),
radiationCoupledBase(p, "undefined", scalarField::null()),
TName_("undefinedT")
TName_("T")
{
refValue() = 0.0;
refGrad() = 0.0;
@ -84,7 +84,7 @@ wideBandDiffusiveRadiationMixedFvPatchScalarField
:
mixedFvPatchScalarField(p, iF),
radiationCoupledBase(p, dict),
TName_(dict.lookup("T"))
TName_(dict.lookupOrDefault<word>("T", "T"))
{
if (dict.found("value"))
{
@ -249,8 +249,7 @@ void Foam::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField::write
{
mixedFvPatchScalarField::write(os);
radiationCoupledBase::write(os);
os.writeKeyword("T") << TName_ << token::END_STATEMENT << nl;
writeEntryIfDifferent<word>(os, "T", "T", TName_);
}

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

@ -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,10 +22,29 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::wideBandDiffusiveRadiationMixedFvPatchScalarField
Foam::radiation::wideBandDiffusiveRadiationMixedFvPatchScalarField
Group
grpThermoBoundaryConditions
Description
Radiation temperature specified
This boundary condition provides a wide-band, diffusive radiation
condition, where the patch temperature is specified.
/heading Patch usage
Example of the boundary condition specification:
\verbatim
myPatch
{
type wideBandDiffusiveRadiation;
value uniform 0;
}
\endverbatim
SeeAlso
Foam::mixedFvPatchScalarField
Foam::radiationCoupledBase
SourceFiles
wideBandDiffusiveRadiationMixedFvPatchScalarField.C