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

Inheritance diagram for CarrierEqn< Type >:

Collaboration diagram for CarrierEqn< Type >:

[legend]

Public Member Functions
	CarrierEqn (const VolField< Type > &psi)
	Construct for a field. More...

	CarrierEqn (const word &psiName, const fvMesh &mesh)
	Construct from a field name and a reference to the mesh. The field. More...

	CarrierEqn (const CarrierEqn< Type > &eqn)
	Copy construct. More...

	CarrierEqn (const tmp< CarrierEqn< Type >> &tEqn)
	Construct from tmp. More...

void	clear ()
	Clear the coefficient values. More...

tmp< VolInternalField< Type > >	residual (const dimensionSet &dims) const
	Return the residual. More...

void	operator+= (const LagrangianEqn< Type > &lEqn)
	Addition assignment. More...

void	operator+= (const tmp< LagrangianEqn< Type >> &tlEqn)
	Addition assignment. More...

void	operator-= (const LagrangianEqn< Type > &lEqn)
	Subtraction assignment. More...

void	operator-= (const tmp< LagrangianEqn< Type >> &tlEqn)
	Subtraction assignment. More...

template<class PsiFieldType >
Foam::tmp< Foam::VolInternalField< Type > >	residual (const dimensionSet &dims, const word &psiName, const PsiFieldType &psi) const

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...

Public Member Functions inherited from CarrierEqnBase
const word &	name () const
	Return the equation name. More...

const fvMesh &	mesh () const
	Return the mesh. More...

Public Attributes
CarrierCoeff< Type, false >	Su
	Explicit coefficient. More...

CarrierCoeff< scalar, true >	Sp
	Implicit coefficient. More...

Additional Inherited Members
Protected Member Functions inherited from refCount
	refCount ()
	Construct null initialising count to 0. More...

	refCount (const refCount &)=delete
	Disallow copy. More...

Protected Member Functions inherited from CarrierEqnBase
	CarrierEqnBase (const word &name, const fvMesh &mesh)
	Construct from components. More...

Protected Attributes inherited from CarrierEqnBase
word	name_
	Symbolic name of the equation or equation term. More...

const fvMesh &	mesh_
	Reference to the mesh. More...

Detailed Description

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

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

Source files

Definition at line 51 of file CarrierEqn.H.

Constructor & Destructor Documentation

◆ CarrierEqn() [1/4]

CarrierEqn ( const VolField< Type > & psi )

Construct for a field.

Definition at line 80 of file CarrierEqn.C.

◆ CarrierEqn() [2/4]

CarrierEqn	(	const word &	psiName,
		const fvMesh &	mesh
	)

Construct from a field name and a reference to the mesh. The field.

reference is not set and the field is assumed to be (dimensionless) unity. This is for volume sources which are expressed per unit volume and therefore have no associated field.

Definition at line 98 of file CarrierEqn.C.