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
template<class PsiType >
	CarrierCoeff (const VolField< PsiType > &psi)
	Construct from a reference to the field. 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, volMesh > &	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...

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 51 of file CarrierCoeff.H.

Constructor & Destructor Documentation

CarrierCoeff() [1/4]

CarrierCoeff

(

const VolField< PsiType > &

psi

)

Construct from a reference to the field.

Definition at line 62 of file CarrierCoeff.C.

CarrierCoeff() [2/4]

CarrierCoeff

(

const CarrierCoeff< Type, Implicit > &

coeff

)

Construct as copy.

Definition at line 69 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 80 of file CarrierCoeff.C.

CarrierCoeff() [4/4]

CarrierCoeff

(

CarrierCoeff< Type, Implicit > &&

coeff

)

Move construct.

Definition at line 92 of file CarrierCoeff.C.

Member Function Documentation

valid()

bool valid

Determine whether this coefficient has values or not.

Definition at line 105 of file CarrierCoeff.C.

clear()

void clear

Clear the coefficient values.

Definition at line 112 of file CarrierCoeff.C.

S()

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

Access the field.

Definition at line 120 of file CarrierCoeff.C.

negate()

void negate

In-place negation.

Definition at line 127 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 136 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 150 of file CarrierCoeff.C.

References Foam::Lagrangianc::accumulate().

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