Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
swarmCorrection Class Referenceabstract
Inheritance diagram for swarmCorrection:
Inheritance graph
[legend]
Collaboration diagram for swarmCorrection:
Collaboration graph
[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 ()
 Destructor. More...
 
virtual tmp< volScalarFieldCs () 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 ()
 Destructor. More...
 
virtual tmp< volScalarFieldCs () const =0
 Swarm correction coefficient. More...
 

Static Public Member Functions

static autoPtr< swarmCorrectionNew (const dictionary &dict, const phasePair &pair)
 
static autoPtr< swarmCorrectionNew (const dictionary &dict, const phasePair &pair)
 

Protected Attributes

const phasePairpair_
 Phase pair. More...
 

Detailed Description

Source files

Source files

Definition at line 52 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.

◆ ~swarmCorrection() [1/2]

virtual ~swarmCorrection ( )
virtual

Destructor.

◆ swarmCorrection() [2/2]

swarmCorrection ( const dictionary dict,
const phasePair pair 
)

Construct from a dictionary and a phase pair.

◆ ~swarmCorrection() [2/2]

virtual ~swarmCorrection ( )
virtual

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]

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

◆ Cs() [1/2]

virtual tmp<volScalarField> Cs ( ) const
pure virtual

Swarm correction coefficient.

Implemented in TomiyamaSwarm, TomiyamaSwarm, noSwarm, and noSwarm.

◆ 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 TomiyamaSwarm, TomiyamaSwarm, noSwarm, and noSwarm.

Member Data Documentation

◆ pair_

const phasePair & pair_
protected

Phase pair.

Definition at line 59 of file swarmCorrection.H.


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