Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
swarmCorrection Class Referenceabstract
Inheritance diagram for swarmCorrection:
[legend]
Collaboration diagram for swarmCorrection:
[legend]

Public Member Functions

 TypeName ("swarmCorrection")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, swarmCorrection, dictionary,(const dictionary &dict, const phasePair &pair),(dict, pair))
 
 swarmCorrection (const dictionary &dict, const phasePair &pair)
 Construct from a dictionary and a phase pair. More...
 
virtual ~swarmCorrection ()=default
 Destructor. More...
 
virtual tmp< volScalarField > Cs () const =0
 Swarm correction coefficient. More...
 
 TypeName ("swarmCorrection")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, swarmCorrection, dictionary,(const dictionary &dict, const phasePair &pair),(dict, pair))
 
 swarmCorrection (const dictionary &dict, const phasePair &pair)
 Construct from a dictionary and a phase pair. More...
 
virtual ~swarmCorrection ()=default
 Destructor. More...
 
virtual tmp< volScalarField > Cs () const =0
 Swarm correction coefficient. More...
 

Static Public Member Functions

static autoPtr< swarmCorrection > New (const dictionary &dict, const phasePair &pair)
 
static autoPtr< swarmCorrection > New (const dictionary &dict, const phasePair &pair)
 

Protected Attributes

const phasePair & pair_
 Phase pair. More...
 

Detailed Description

Source files

Source files

Definition at line 55 of file swarmCorrection.H.

Constructor & Destructor Documentation

◆ swarmCorrection() [1/2]

swarmCorrection ( const dictionary &  dict,
const phasePair &  pair 
)

Construct from a dictionary and a phase pair.

Definition at line 43 of file swarmCorrection.C.

◆ ~swarmCorrection() [1/2]

virtual ~swarmCorrection ( )
virtualdefault

Destructor.

◆ swarmCorrection() [2/2]

swarmCorrection ( const dictionary &  dict,
const phasePair &  pair 
)

Construct from a dictionary and a phase pair.

◆ ~swarmCorrection() [2/2]

virtual ~swarmCorrection ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName() [1/2]

TypeName ( "swarmCorrection"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable ( autoPtr  ,
swarmCorrection  ,
dictionary  ,
(const dictionary &dict, const phasePair &pair)  ,
(dict, pair)   
)

◆ New() [1/2]

Foam::autoPtr< Foam::swarmCorrection > New ( const dictionary &  dict,
const phasePair &  pair 
)
static

Definition at line 56 of file swarmCorrection.C.

References Foam::abort(), dict, Foam::endl(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), and Foam::Info.

Here is the call graph for this function:

◆ Cs() [1/2]

virtual tmp< volScalarField > Cs ( ) const
pure virtual

Swarm correction coefficient.

Implemented in noSwarm, TomiyamaSwarm, noSwarm, and TomiyamaSwarm.

◆ TypeName() [2/2]

TypeName ( "swarmCorrection"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable ( autoPtr  ,
swarmCorrection  ,
dictionary  ,
(const dictionary &dict, const phasePair &pair)  ,
(dict, pair)   
)

◆ New() [2/2]

static autoPtr< swarmCorrection > New ( const dictionary &  dict,
const phasePair &  pair 
)
static

◆ Cs() [2/2]

virtual tmp< volScalarField > Cs ( ) const
pure virtual

Swarm correction coefficient.

Implemented in noSwarm, TomiyamaSwarm, noSwarm, and TomiyamaSwarm.

Member Data Documentation

◆ pair_

const phasePair & pair_
protected

Phase pair.

Definition at line 62 of file swarmCorrection.H.

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