Public Member Functions | Private Attributes
constantScatter Class Reference

Constant radiation scatter coefficient. More...

Inheritance diagram for constantScatter:
Inheritance graph
[legend]
Collaboration diagram for constantScatter:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("constantScatter")
 Runtime type information. More...
 
 constantScatter (const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
virtual ~constantScatter ()
 Destructor. More...
 
tmp< volScalarFieldsigmaEff () const
 Return scatter coefficient. More...
 
- Public Member Functions inherited from scatterModel
 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...
 

Private Attributes

dictionary coeffsDict_
 Coefficients dictionary. More...
 
dimensionedScalar sigma_
 Scattering coefficient / [1/m]. More...
 
dimensionedScalar C_
 Linear-anisotropic phase function coefficient / []. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from scatterModel
static autoPtr< scatterModelNew (const dictionary &dict, const fvMesh &mesh)
 
- Protected Attributes inherited from scatterModel
const fvMeshmesh_
 Reference to the fvMesh. More...
 

Detailed Description

Constant radiation scatter coefficient.

Source files

Definition at line 50 of file constantScatter.H.

Constructor & Destructor Documentation

◆ constantScatter()

constantScatter ( const dictionary dict,
const fvMesh mesh 
)

Construct from components.

Definition at line 50 of file constantScatter.C.

◆ ~constantScatter()

~constantScatter ( )
virtual

Destructor.

Definition at line 64 of file constantScatter.C.

Member Function Documentation

◆ TypeName()

TypeName ( "constantScatter"  )

Runtime type information.

◆ sigmaEff()

Foam::tmp< Foam::volScalarField > sigmaEff ( ) const
virtual

Return scatter coefficient.

Implements scatterModel.

Definition at line 71 of file constantScatter.C.

References IOobject::NO_READ, and IOobject::NO_WRITE.

Field Documentation

◆ coeffsDict_

dictionary coeffsDict_
private

Coefficients dictionary.

Definition at line 58 of file constantScatter.H.

◆ sigma_

dimensionedScalar sigma_
private

Scattering coefficient / [1/m].

Definition at line 61 of file constantScatter.H.

◆ C_

dimensionedScalar C_
private

Linear-anisotropic phase function coefficient / [].

-1 < C < 1

  • = backward scattering 0 = isotropic scattering (reasonable default value) + = forward scattering

Definition at line 68 of file constantScatter.H.


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