scatterModel Class Referenceabstract

Base class for radiation scattering. More...

Inheritance diagram for scatterModel:
Collaboration diagram for scatterModel:

Public Member Functions

 TypeName ("scatterModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, scatterModel, dictionary,(const dictionary &dict, const fvMesh &mesh),(dict, mesh))
 
 scatterModel (const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
virtual ~scatterModel ()
 Destructor. More...
 
virtual tmp< volScalarFieldsigmaEff () const =0
 Return scatter coefficient. More...
 

Static Public Member Functions

static autoPtr< scatterModelNew (const dictionary &dict, const fvMesh &mesh)
 

Protected Attributes

const fvMeshmesh_
 Reference to the fvMesh. More...
 

Detailed Description

Base class for radiation scattering.

Definition at line 50 of file scatterModel.H.

Constructor & Destructor Documentation

◆ scatterModel()

scatterModel ( const dictionary dict,
const fvMesh mesh 
)

Construct from components.

Definition at line 44 of file scatterModel.C.

◆ ~scatterModel()

~scatterModel ( )
virtual

Destructor.

Definition at line 55 of file scatterModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "scatterModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
scatterModel  ,
dictionary  ,
(const dictionary &dict, const fvMesh &mesh ,
(dict, mesh  
)

◆ New()

Foam::autoPtr< Foam::radiationModels::scatterModel > New ( const dictionary dict,
const fvMesh mesh 
)
static

Definition at line 33 of file scatterModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), mesh, and Foam::nl.

Here is the call graph for this function:

◆ sigmaEff()

virtual tmp<volScalarField> sigmaEff ( ) const
pure virtual

Return scatter coefficient.

Implemented in constant, cloud, and noScatter.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

Reference to the fvMesh.

Definition at line 58 of file scatterModel.H.


The documentation for this class was generated from the following files: