Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
barotropicCompressibilityModel Class Referenceabstract

Abstract class for barotropic compressibility models. More...

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

Public Member Functions

 TypeName ("barotropicCompressibilityModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, barotropicCompressibilityModel, dictionary,( const dictionary &compressibilityProperties, const volScalarField &gamma, const word &psiName ),(compressibilityProperties, gamma, psiName))
 
 barotropicCompressibilityModel (const dictionary &compressibilityProperties, const volScalarField &gamma, const word &psiName="psi")
 Construct from components. More...
 
virtual ~barotropicCompressibilityModel ()
 Destructor. More...
 
const dictionarycompressibilityProperties () const
 Return the phase transport properties dictionary. More...
 
const volScalarFieldpsi () const
 Return the compressibility. More...
 
virtual void correct ()=0
 Correct the compressibility. More...
 
virtual bool read (const dictionary &compressibilityProperties)=0
 Read compressibilityProperties dictionary. More...
 

Static Public Member Functions

static autoPtr< barotropicCompressibilityModelNew (const dictionary &compressibilityProperties, const volScalarField &gamma, const word &psiName="psi")
 Return a reference to the selected compressibility model. More...
 

Protected Member Functions

 barotropicCompressibilityModel (const barotropicCompressibilityModel &)
 Disallow copy construct. More...
 
void operator= (const barotropicCompressibilityModel &)
 Disallow default bitwise assignment. More...
 

Protected Attributes

dictionary compressibilityProperties_
 
volScalarField psi_
 
const volScalarFieldgamma_
 

Detailed Description

Abstract class for barotropic compressibility models.

Source files

Definition at line 61 of file barotropicCompressibilityModel.H.

Constructor & Destructor Documentation

Disallow copy construct.

barotropicCompressibilityModel ( const dictionary compressibilityProperties,
const volScalarField gamma,
const word psiName = "psi" 
)

Construct from components.

Definition at line 42 of file barotropicCompressibilityModel.C.

References barotropicCompressibilityModel::read().

Here is the call graph for this function:

virtual ~barotropicCompressibilityModel ( )
inlinevirtual

Destructor.

Definition at line 128 of file barotropicCompressibilityModel.H.

Member Function Documentation

void operator= ( const barotropicCompressibilityModel )
protected

Disallow default bitwise assignment.

TypeName ( "barotropicCompressibilityModel"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
barotropicCompressibilityModel  ,
dictionary  ,
( const dictionary &compressibilityProperties, const volScalarField &gamma, const word &psiName )  ,
(compressibilityProperties, gamma, psiName)   
)
Foam::autoPtr< Foam::barotropicCompressibilityModel > New ( const dictionary compressibilityProperties,
const volScalarField gamma,
const word psiName = "psi" 
)
static

Return a reference to the selected compressibility model.

Definition at line 32 of file barotropicCompressibilityModelNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), and Foam::nl.

Here is the call graph for this function:

const dictionary& compressibilityProperties ( ) const
inline

Return the phase transport properties dictionary.

Definition at line 135 of file barotropicCompressibilityModel.H.

References barotropicCompressibilityModel::compressibilityProperties_.

const volScalarField& psi ( ) const
inline

Return the compressibility.

Definition at line 141 of file barotropicCompressibilityModel.H.

References barotropicCompressibilityModel::correct(), barotropicCompressibilityModel::psi_, and barotropicCompressibilityModel::read().

Here is the call graph for this function:

virtual void correct ( )
pure virtual

Correct the compressibility.

Implemented in Chung, Wallis, and linear.

Referenced by barotropicCompressibilityModel::psi().

Here is the caller graph for this function:

bool read ( const dictionary compressibilityProperties)
pure virtual

Read compressibilityProperties dictionary.

Implemented in Chung, Wallis, and linear.

Definition at line 67 of file barotropicCompressibilityModel.C.

Referenced by barotropicCompressibilityModel::barotropicCompressibilityModel(), barotropicCompressibilityModel::psi(), linear::read(), Wallis::read(), and Chung::read().

Here is the caller graph for this function:

Member Data Documentation

dictionary compressibilityProperties_
protected
volScalarField psi_
protected
const volScalarField& gamma_
protected

Definition at line 71 of file barotropicCompressibilityModel.H.


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