CarrierCoeff< Type, Implicit > Class Template Reference

Class to store a coefficient of a carrier equation. More...

Inheritance diagram for CarrierCoeff< Type, Implicit >:

Public Member Functions
	CarrierCoeff (const CarrierEqnBase &eqn)
	Construct from a reference to the equation. More...
	CarrierCoeff (const CarrierCoeff< Type, Implicit > &coeff)
	Construct as copy. More...
	CarrierCoeff (CarrierCoeff< Type, Implicit > &coeff, const bool reuse)
	Construct as copy or reuse as specified. More...
	CarrierCoeff (CarrierCoeff< Type, Implicit > &&coeff)
	Move construct. More...
bool	valid () const
	Determine whether this coefficient has values or not. More...
void	clear ()
	Clear the coefficient values. More...
const DimensionedField< Type, fvMesh > &	S () const
	Access the field. More...
void	negate ()
	In-place negation. More...
void	operator+= (const LagrangianCoeff< Type, Implicit > &lCoeff)
	Addition assignment. More...
void	operator-= (const LagrangianCoeff< Type, Implicit > &lCoeff)
	Subtraction assignment. More...
void	operator*= (const dimensionedScalar &s)
	Multiply assignment. More...
void	operator/= (const dimensionedScalar &s)
	Division assignment. More...

Detailed Description

template<class Type, bool Implicit>
class Foam::CarrierCoeff< Type, Implicit >

Class to store a coefficient of a carrier equation.

Source files

• CarrierCoeff.H
• CarrierCoeff.C

Definition at line 52 of file CarrierCoeff.H.

Constructor & Destructor Documentation

CarrierCoeff() [1/4]

CarrierCoeff

(

const CarrierEqnBase &

eqn

)

Construct from a reference to the equation.

Definition at line 63 of file CarrierCoeff.C.

CarrierCoeff() [2/4]

CarrierCoeff

(

const CarrierCoeff< Type, Implicit > &

coeff

)

Construct as copy.

Definition at line 70 of file CarrierCoeff.C.

CarrierCoeff() [3/4]

CarrierCoeff	(	CarrierCoeff< Type, Implicit > &	coeff,
		const bool	reuse
	)

Construct as copy or reuse as specified.

Definition at line 81 of file CarrierCoeff.C.

CarrierCoeff() [4/4]

CarrierCoeff

(

CarrierCoeff< Type, Implicit > &&

coeff

)

Move construct.

Definition at line 93 of file CarrierCoeff.C.

Member Function Documentation

valid()

bool valid

Determine whether this coefficient has values or not.

Definition at line 106 of file CarrierCoeff.C.

Referenced by Foam::operator+=(), and Foam::operator-=().

Here is the caller graph for this function:

clear()

void clear

Clear the coefficient values.

Definition at line 113 of file CarrierCoeff.C.

S()

const Foam::DimensionedField< Type, Foam::fvMesh > & S

Access the field.

Definition at line 121 of file CarrierCoeff.C.

Referenced by Foam::operator+=(), and Foam::operator-=().

Here is the caller graph for this function:

negate()

void negate

In-place negation.

Definition at line 128 of file CarrierCoeff.C.

References Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

operator+=()

void operator+=

(

const LagrangianCoeff< Type, Implicit > &

lCoeff

)

Addition assignment.

Definition at line 137 of file CarrierCoeff.C.

References Foam::Lagrangianc::accumulate().

Here is the call graph for this function:

operator-=()

void operator-=

(

const LagrangianCoeff< Type, Implicit > &

lCoeff

)

Subtraction assignment.

Definition at line 151 of file CarrierCoeff.C.

References Foam::Lagrangianc::accumulate().

Here is the call graph for this function:

operator*=()

void operator*=

(

const dimensionedScalar &

s

)

Multiply assignment.

Definition at line 165 of file CarrierCoeff.C.

References s(), and Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

operator/=()

void operator/=

(

const dimensionedScalar &

s

)

Division assignment.

Definition at line 175 of file CarrierCoeff.C.

References s(), and Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

---

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

• src/Lagrangian/cloud/clouds/coupled/CarrierCoeff.H
• src/Lagrangian/cloud/clouds/coupled/CarrierCoeff.C