temperatureCoupledBase, turbulentHeatFluxTemperatureFvPatchScalarField: updated docs

Provided by Bruno Santos
Resolves bug-report http://www.openfoam.org/mantisbt/view.php?id=1875
This commit is contained in:
Henry Weller
2015-10-25 17:08:29 +00:00
parent f531767eff
commit 3f3a39e2e8
2 changed files with 40 additions and 14 deletions

View File

@ -25,17 +25,41 @@ Class
Foam::temperatureCoupledBase
Description
Common functions for use in temperature coupled boundaries. For now only
Common functions for use in temperature coupled boundaries.
kappa() : heat conduction at patch. Gets supplied how to lookup/calculate
kappa:
For now only provides the following methods:
- kappa() : heat conduction at patch. Gets supplied how to lookup/calculate
'kappa':
- 'lookup' : lookup volScalarField (or volSymmTensorField) with name
- 'fluidThermo' : use fluidThermo and default compressible::turbulenceModel
to calculate kappa
defined in 'kappaName'
- 'fluidThermo' : use fluidThermo and default
compressible::turbulenceModel to calculate kappa
- 'solidThermo' : use solidThermo kappa()
- 'directionalSolidThermo': uses look up for volSymmTensorField for
transformed kappa vector. Named 'Anialpha' in solid solver
transformed kappa vector. Field name definable in 'alphaAniName',
named 'Anialpha' in solid solver by default
\heading Keywords provided by this class
\table
Property | Description | Required | Default value
kappa | heat conduction type at patch, as listed above | yes |
kappaName | Name of thermal conductivity field | yes |
alphaAniName | name of the non-isotropic alpha | no | 'Anialpha'
\endtable
Usage examples:
\verbatim
nonIsotropicWall
{
...
kappa directionalSolidThermo;
kappaName none;
alphaAniName Anialpha;
...
}
\endverbatim
SourceFiles
temperatureCoupledBase.C

View File

@ -35,12 +35,15 @@ Description
Property | Description | Required | Default value
heatSource | 'power' [W] or 'flux' [W/m^2] | yes |
q | heat power or flux field | yes |
kappa | inherited from Foam::temperatureCoupledBase | yes |
kappa | inherited from temperatureCoupledBase | yes |
kappaName | inherited from temperatureCoupledBase | yes |
Qr | name of the radiative flux field | yes |
value | initial temperature value | no | calculated
gradient | initial gradient value | no | 0.0
\endtable
Note: If needed, both 'value' and 'gradient' must be defined to be used.
Example usage:
\verbatim
hotWall
@ -49,9 +52,8 @@ Description
heatSource flux;
q uniform 10;
kappa fluidThermo;
kappaName none;
Qr none;
gradient uniform 0;
value uniform 300;
}
\endverbatim