Public Member Functions | Static Public 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...
 
 barotropicCompressibilityModel (const barotropicCompressibilityModel &)
 Disallow default bitwise copy construction. More...
 
virtual ~barotropicCompressibilityModel ()
 Destructor. More...
 
const dictionary & compressibilityProperties () const
 Return the phase transport properties dictionary. More...
 
const volScalarField & psi () const
 Return the compressibility. More...
 
virtual void correct ()=0
 Correct the compressibility. More...
 
virtual bool read (const dictionary &compressibilityProperties)=0
 Read compressibilityProperties dictionary. More...
 
void operator= (const barotropicCompressibilityModel &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

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

Protected Attributes

dictionary compressibilityProperties_
 
volScalarField psi_
 
const volScalarField & gamma_
 

Detailed Description

Abstract class for barotropic compressibility models.

Source files

Definition at line 61 of file barotropicCompressibilityModel.H.

Constructor & Destructor Documentation

◆ barotropicCompressibilityModel() [1/2]

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

Construct from components.

Definition at line 41 of file barotropicCompressibilityModel.C.

◆ barotropicCompressibilityModel() [2/2]

barotropicCompressibilityModel ( const barotropicCompressibilityModel &  )

Disallow default bitwise copy construction.

◆ ~barotropicCompressibilityModel()

virtual ~barotropicCompressibilityModel ( )
inlinevirtual

Destructor.

Definition at line 121 of file barotropicCompressibilityModel.H.

Member Function Documentation

◆ TypeName()

TypeName ( "barotropicCompressibilityModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
barotropicCompressibilityModel  ,
dictionary  ,
(const dictionary &compressibilityProperties, const volScalarField &gamma, const word &psiName)  ,
(compressibilityProperties, gamma, psiName)   
)

◆ New()

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 31 of file barotropicCompressibilityModelNew.C.

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

Here is the call graph for this function:

◆ compressibilityProperties()

const dictionary& compressibilityProperties ( ) const
inline

Return the phase transport properties dictionary.

Definition at line 128 of file barotropicCompressibilityModel.H.

References barotropicCompressibilityModel::compressibilityProperties_.

Referenced by barotropicCompressibilityModel::New().

Here is the caller graph for this function:

◆ psi()

const volScalarField& psi ( ) const
inline

Return the compressibility.

Definition at line 134 of file barotropicCompressibilityModel.H.

References barotropicCompressibilityModel::psi_.

◆ correct()

virtual void correct ( )
pure virtual

Correct the compressibility.

Implemented in Wallis, linear, and Chung.

◆ read()

bool read ( const dictionary &  compressibilityProperties)
pure virtual

Read compressibilityProperties dictionary.

Implemented in Wallis, linear, and Chung.

Definition at line 66 of file barotropicCompressibilityModel.C.

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

Here is the caller graph for this function:

◆ operator=()

void operator= ( const barotropicCompressibilityModel &  )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ compressibilityProperties_

dictionary compressibilityProperties_
protected

Definition at line 67 of file barotropicCompressibilityModel.H.

Referenced by barotropicCompressibilityModel::compressibilityProperties().

◆ psi_

volScalarField psi_
protected

Definition at line 69 of file barotropicCompressibilityModel.H.

Referenced by linear::linear(), and barotropicCompressibilityModel::psi().

◆ gamma_

const volScalarField& gamma_
protected

Definition at line 70 of file barotropicCompressibilityModel.H.

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