radiationModels/derivedFvPatchFields: Corrected documentation

Resolves bug-report http://www.openfoam.org/mantisbt/view.php?id=1687
This commit is contained in:
Henry
2015-05-24 19:02:41 +01:00
parent 605b3ff820
commit 03b11e37ad
4 changed files with 15 additions and 14 deletions

View File

@ -38,7 +38,7 @@ Description
\table
Property | Description | Required | Default value
T | temperature field name | no | T
emissivityMode | emissivity mode: solidThermo or lookup | yes |
emissivityMode | emissivity mode: solidRadiation or lookup | yes |
\endtable
Example of the boundary condition specification:
@ -47,15 +47,15 @@ Description
{
type greyDiffusiveRadiation;
T T;
emissivityMode solidThermo;
emissivityMode solidRadiation;
value uniform 0;
}
\endverbatim
SeeAlso
Foam::radiationCoupledBase
Foam::radiation::radiationModel
Foam::radiation::fvDOM
Foam::radiationCoupledBase
Foam::mixedFvPatchField
SourceFiles
@ -191,8 +191,8 @@ public:
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace radiation
} // End namespace Foam
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

View File

@ -36,7 +36,7 @@ Description
\table
Property | Description | Required | Default value
Qro | external radiative heat flux | yes |
emissivityMode | emissivity mode: solidThermo or lookup | yes |
emissivityMode | emissivity mode: solidRadiation or lookup | yes |
\endtable
Example of the boundary condition specification:
@ -45,15 +45,15 @@ Description
{
type greyDiffusiveRadiationViewFactor;
Qro uniform 0;
emissivityMode solidThermo;
emissivityMode solidRadiation;
value uniform 0;
}
\endverbatim
SeeAlso
Foam::radiationCoupledBase
Foam::radiation::radiationModel
Foam::radiation::viewFactor
Foam::radiationCoupledBase
Foam::fixedValueFvPatchField
SourceFiles
@ -73,6 +73,7 @@ namespace Foam
{
namespace radiation
{
/*---------------------------------------------------------------------------*\
Class greyDiffusiveViewFactorFixedValueFvPatchScalarField declaration
\*---------------------------------------------------------------------------*/
@ -186,8 +187,8 @@ public:
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace radiation
} // End namespace Foam
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

View File

@ -32,7 +32,6 @@ License
// * * * * * * * * * * * * * Static Member Data * * * * * * * * * * * * * * //
namespace Foam
{
defineTypeNameAndDebug(radiationCoupledBase, 0);

View File

@ -22,14 +22,14 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::radiationCoupledBase
radiationCoupledBase
Description
Common functions to emissivity. It gets supplied from lookup into a
dictionary or calculated by the solidThermo:
- 'lookup' : lookup volScalarField with name
- 'solidThermo' : use solidThermo emissivity()
- 'lookup' : Read the patch emissivity field from the dictionary
- 'solidRadiation' : Use the emissivity field mapped from the adjacent solid
SourceFiles
radiationCoupledBase.C
@ -83,8 +83,8 @@ protected:
//- How to get emissivity
const emissivityMethodType method_;
//- Emissivity
// Cached locally when is read from dictionary (lookup mode)
//- Emissivity
// Cached locally when is read from dictionary (lookup mode)
scalarField emissivity_;
@ -124,6 +124,7 @@ public:
//- Destructor
virtual ~radiationCoupledBase();
// Member functions
// Access