APIdiffCoef Class Reference
Inheritance diagram for APIdiffCoef:
Collaboration diagram for APIdiffCoef:

Public Member Functions

 TypeName ("APIdiffCoef")
 Runtime type information. More...
 
 APIdiffCoef (const word &name, const scalar a, const scalar b, const scalar wf, const scalar wa)
 Construct from components. More...
 
 APIdiffCoef (const word &name, const unitConversions &units, const dictionary &dict)
 Construct from name and dictionary. More...
 
virtual tmp< Function2< scalar > > clone () const
 Construct and return a clone. More...
 
virtual scalar value (scalar p, scalar T) const
 API vapour mass diffusivity function using properties from. More...
 
scalar value (scalar p, scalar T, scalar Wa) const
 API vapour mass diffusivity function using properties from. More...
 
virtual void write (Ostream &os, const unitConversions &units) const
 Write the function coefficients. More...
 
- Public Member Functions inherited from FieldFunction2< scalar, APIdiffCoef >
 FieldFunction2 (const word &name)
 Construct from name. More...
 
virtual ~FieldFunction2 ()
 Destructor. More...
 
virtual tmp< Field< scalar > > value (const scalarField &x, const scalarField &y) const
 Return value as a function of two scalar fields. More...
 
- Public Member Functions inherited from Function2< Type >
 TypeName ("Function2")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Function2, dictionary,(const word &name, const Function2s::unitConversions &units, const dictionary &dict),(name, units, dict))
 
 declareRunTimeSelectionTable (autoPtr, Function2, Istream,(const word &name, const Function2s::unitConversions &units, Istream &is),(name, units, is))
 
 Function2 (const word &name)
 Construct from name. More...
 
 Function2 (const Function2< Type > &f2)
 Copy constructor. More...
 
virtual ~Function2 ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. More...
 
void operator= (const Function2< Type > &)
 Assignment. More...
 
- Public Member Functions inherited from refCount
int count () const
 Return the current reference count. More...
 
bool unique () const
 Return true if the reference count is zero. More...
 
void operator++ ()
 Increment the reference count. More...
 
void operator++ (int)
 Increment the reference count. More...
 
void operator-- ()
 Decrement the reference count. More...
 
void operator-- (int)
 Decrement the reference count. More...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. More...
 

Additional Inherited Members

- Public Types inherited from Function2< Type >
typedef Type returnType
 
- Static Public Member Functions inherited from Function2< Type >
static autoPtr< Function2< Type > > New (const word &name, const Function2s::unitConversions &units, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function2< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &yUnits, const unitConversion &valueUnits, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function2< Type > > New (const word &name, const Function2s::unitConversions &units, const word &Function2Type, Istream &is)
 Select from Istream. More...
 
static autoPtr< Function2< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &yUnits, const unitConversion &valueUnits, const word &Function2Type, Istream &is)
 Select from Istream. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 
- Protected Attributes inherited from Function2< Type >
const word name_
 Name of entry. More...
 

Detailed Description

Definition at line 53 of file APIdiffCoef.H.

Constructor & Destructor Documentation

◆ APIdiffCoef() [1/2]

APIdiffCoef ( const word name,
const scalar  a,
const scalar  b,
const scalar  wf,
const scalar  wa 
)

Construct from components.

Definition at line 42 of file APIdiffCoef.C.

Referenced by APIdiffCoef::clone().

Here is the caller graph for this function:

◆ APIdiffCoef() [2/2]

APIdiffCoef ( const word name,
const unitConversions units,
const dictionary dict 
)

Construct from name and dictionary.

Definition at line 61 of file APIdiffCoef.C.

References Foam::assertNoConvertUnits(), dict, and Foam::units().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "APIdiffCoef"  )

Runtime type information.

◆ clone()

virtual tmp<Function2<scalar> > clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from FieldFunction2< scalar, APIdiffCoef >.

Definition at line 93 of file APIdiffCoef.H.

References APIdiffCoef::APIdiffCoef().

Here is the call graph for this function:

◆ value() [1/2]

virtual scalar value ( scalar  p,
scalar  T 
) const
inlinevirtual

API vapour mass diffusivity function using properties from.

construction

Implements FieldFunction2< scalar, APIdiffCoef >.

Definition at line 106 of file APIdiffCoef.H.

◆ value() [2/2]

scalar value ( scalar  p,
scalar  T,
scalar  Wa 
) const
inline

API vapour mass diffusivity function using properties from.

construction - with specified binary pair

Definition at line 113 of file APIdiffCoef.H.

◆ write()

void write ( Ostream os,
const unitConversions units 
) const
virtual

Write the function coefficients.

Implements Function2< Type >.

Definition at line 82 of file APIdiffCoef.C.

References Foam::writeEntry().

Here is the call graph for this function:

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