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

DOC: radiation fvOptions: improve documentation

Browse Source
This commit is contained in:
Kutalmis Bercin
2021-03-19 13:41:13 +00:00
committed by Andrew Heather
parent 644857ba9e
commit 4ad4783e5f
2 changed files with 27 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/thermophysicalModels/radiation/fvOptions/radiation/radiation.C
View File

@ -6,6 +6,7 @@
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2017 OpenFOAM Foundation
Copyright (C) 2021 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
@ -37,13 +38,7 @@ namespace Foam
namespace fv
{
defineTypeNameAndDebug(radiation, 0);
addToRunTimeSelectionTable
(
option,
radiation,
dictionary
);
addToRunTimeSelectionTable(option, radiation, dictionary);
}
}
@ -60,8 +55,7 @@ Foam::fv::radiation::radiation
:
option(sourceName, modelType, dict, mesh)
{
const basicThermo& thermo =
mesh_.lookupObject<basicThermo>(basicThermo::dictName);
const auto& thermo = mesh_.lookupObject<basicThermo>(basicThermo::dictName);
fieldNames_.setSize(1);
fieldNames_[0] = thermo.he().name();
@ -86,8 +80,7 @@ void Foam::fv::radiation::addSup
const label fieldi
)
{
const basicThermo& thermo =
mesh_.lookupObject<basicThermo>(basicThermo::dictName);
const auto& thermo = mesh_.lookupObject<basicThermo>(basicThermo::dictName);
radiation_->correct();

29
src/thermophysicalModels/radiation/fvOptions/radiation/radiation.H
View File

@ -6,6 +6,7 @@
\\/ M anipulation |
-------------------------------------------------------------------------------
Copyright (C) 2017 OpenFOAM Foundation
Copyright (C) 2021 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
@ -27,17 +28,33 @@ Class
Foam::fv::radiation
Description
Calculates and applies the radiation source to the energy equation.
Applies radiation sources (i.e. \c Sh)
to the energy equation for compressible flows.
Usage
Example usage:
Minimal example by using \c constant/fvOptions:
\verbatim
radiationCoeffs
radiation1
{
fields (h); // Name of energy field
// Mandatory entries (unmodifiable)
type radiation;
fields (h);
// Mandatory/Optional (inherited) entries
...
}
\endverbatim
where the entries mean:
\table
Property | Description | Type | Reqd | Dflt
type | Type name: radiation | word | yes | -
fields | Name of operand energy field | word | yes | -
\endtable
The inherited entries are elaborated in:
- \link fvOption.H \endlink
SourceFiles
radiation.C
@ -58,14 +75,14 @@ namespace fv
{
/*---------------------------------------------------------------------------*\
Class radiation Declaration
Class radiation Declaration
\*---------------------------------------------------------------------------*/
class radiation
:
public option
{
// Private data
// Private Data
//- The radiation model pointer
autoPtr<Foam::radiation::radiationModel> radiation_;