CarrierEqn< Type > Class Template Reference

Class to store the coefficients of a term in a carrier equation. More...

Collaboration diagram for CarrierEqn< Type >:

Public Member Functions
	CarrierEqn (const VolField< Type > &psi)
	Construct from a reference to the field. More...
void	clear ()
	Clear the coefficient values. More...
void	operator+= (const LagrangianEqn< Type > &lEqn)
	Addition assignment. More...
void	operator-= (const LagrangianEqn< Type > &lEqn)
	Subtraction assignment. More...

Public Attributes
const VolField< Type > &	psi
	Reference to the field. More...
CarrierCoeff< Type, false >	Su
	Explicit coefficient. More...
CarrierCoeff< scalar, true >	Sp
	Implicit coefficient. More...

Detailed Description

template<class Type>
class Foam::CarrierEqn< Type >

Class to store the coefficients of a term in a carrier equation.

Source files

• CarrierEqn.H
• CarrierEqn.C

Definition at line 51 of file CarrierEqn.H.

Constructor & Destructor Documentation

CarrierEqn()

CarrierEqn

(

const VolField< Type > &

psi

)

Construct from a reference to the field.

Definition at line 31 of file CarrierEqn.C.

Member Function Documentation

clear()

void clear

Clear the coefficient values.

Definition at line 42 of file CarrierEqn.C.

References Foam::fvc::Sp(), and Foam::fvc::Su().

Here is the call graph for this function:

operator+=()

void operator+=

(

const LagrangianEqn< Type > &

lEqn

)

Addition assignment.

Definition at line 52 of file CarrierEqn.C.

References LagrangianEqn< Type >::allDiagonalSp(), LagrangianEqn< Type >::allDiagonalSu(), Foam::fvc::Sp(), and Foam::fvc::Su().

Here is the call graph for this function:

operator-=()

void operator-=

(

const LagrangianEqn< Type > &

lEqn

)

Subtraction assignment.

Definition at line 60 of file CarrierEqn.C.

References LagrangianEqn< Type >::allDiagonalSp(), LagrangianEqn< Type >::allDiagonalSu(), Foam::fvc::Sp(), and Foam::fvc::Su().

Here is the call graph for this function:

Member Data Documentation

psi

const VolField<Type>& psi

Reference to the field.

Definition at line 58 of file CarrierEqn.H.

Su

CarrierCoeff<Type, false> Su

Explicit coefficient.

Definition at line 61 of file CarrierEqn.H.

Sp

CarrierCoeff<scalar, true> Sp

Implicit coefficient.

Definition at line 64 of file CarrierEqn.H.

---

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

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