LagrangianSp< Type > Class Template Reference

Wrapper around LagrangianCoeff to specialise for the implicit coefficient. Trivial at present. The idea eventually is to make the vector implicit coefficient automatically build tensor coefficients as and when a model supplies tensor values. More...

Inheritance diagram for LagrangianSp< Type >:

Collaboration diagram for LagrangianSp< Type >:

Public Member Functions
	LagrangianSp (const LagrangianEqnBase &, const LagrangianSp< Type > &Sp)
	Construct as copy. More...
	LagrangianSp (const LagrangianEqnBase &, LagrangianSp< Type > &Sp, const bool reuse)
	Construct as copy or reuse as specified. More...
	LagrangianSp (LagrangianSp< Type > &&Sp)
	Move construct. More...
tmp< LagrangianCoeff< scalar, true > >	A () const
	Return the scalar diagonal coefficient. More...
tmp< LagrangianCoeff< Type, false > >	H () const
	Return the scalar off-diagonal coefficients. More...
tmp< LagrangianCoeff< Type, false > >	Su () const
	Return the equivalent explicit coefficient. More...
tmp< LagrangianCoeff< Type, false > >	Su (const LagrangianEqn< Type > &) const
	Return the equivalent explicit coefficient. Pass the equation. More...
template<class OtherType >
void	operator+= (const LagrangianSp< OtherType > &)
	Addition assignment. More...
template<class OtherType >
void	operator-= (const LagrangianSp< OtherType > &Sp)
	Subtraction assignment. More...
template<template< class > class PrimitiveField>
void	operator+= (const LagrangianSubField< scalar, PrimitiveField > &S)
template<template< class > class PrimitiveField>
void	operator+= (const LagrangianSubField< tensor, PrimitiveField > &S)
template<template< class > class PrimitiveField>
void	operator+= (const tmp< LagrangianSubField< scalar, PrimitiveField >> &tS)
template<template< class > class PrimitiveField>
void	operator+= (const tmp< LagrangianSubField< tensor, PrimitiveField >> &tS)
template<template< class > class PrimitiveField>
void	operator-= (const LagrangianSubField< scalar, PrimitiveField > &S)
template<template< class > class PrimitiveField>
void	operator-= (const LagrangianSubField< tensor, PrimitiveField > &S)
template<template< class > class PrimitiveField>
void	operator-= (const tmp< LagrangianSubField< scalar, PrimitiveField >> &tS)
template<template< class > class PrimitiveField>
void	operator-= (const tmp< LagrangianSubField< tensor, PrimitiveField >> &tS)
Public Member Functions inherited from LagrangianCoeff< scalar, true >
	LagrangianCoeff (const LagrangianEqnBase &eqn)
	Construct empty. More...
	LagrangianCoeff (const LagrangianEqnBase &eqn, const LagrangianCoeff< scalar, Implicit > &coeff)
	Construct as copy. More...
	LagrangianCoeff (const LagrangianEqnBase &eqn, LagrangianCoeff< scalar, Implicit > &coeff, const bool reuse)
	Construct as copy or reuse as specified. More...
	LagrangianCoeff (LagrangianCoeff< scalar, Implicit > &&coeff)
	Move construct. More...
	LagrangianCoeff (const LagrangianEqnBase &eqn, const LagrangianSubField< scalar, PrimitiveField > &)
	Construct from a field. More...
	LagrangianCoeff (const LagrangianEqnBase &eqn, const tmp< LagrangianSubField< scalar, PrimitiveField >> &)
	Construct from a tmp field. More...
const LagrangianEqnBase &	eqn () const
	Access the equation. More...
bool	valid () const
	Determine whether this coefficient has values or not. More...
const LagrangianSubField< scalar > &	S () const
	Access the coefficient. More...
void	negate ()
	In-place negation. More...
void	operator+= (const LagrangianSubField< scalar, PrimitiveField > &)
	Addition assignment. More...
void	operator+= (const tmp< LagrangianSubField< scalar, PrimitiveField >> &)
	Addition assignment. More...
void	operator+= (const LagrangianCoeff< scalar, Implicit > &)
	Addition assignment. More...
void	operator+= (const LagrangianCoeff< OtherType, Implicit > &)
	Addition assignment. More...
void	operator+= (const dimensioned< scalar > &)
	Addition assignment. More...
void	operator+= (const zero)
	Addition assignment. More...
void	operator-= (const LagrangianSubField< scalar, PrimitiveField > &)
	Subtraction assignment. More...
void	operator-= (const tmp< LagrangianSubField< scalar, PrimitiveField >> &)
	Subtraction assignment. More...
void	operator-= (const LagrangianCoeff< scalar, Implicit > &)
	Subtraction assignment. More...
void	operator-= (const LagrangianCoeff< OtherType, Implicit > &)
	Addition assignment. More...
void	operator-= (const dimensioned< scalar > &)
	Subtraction assignment. More...
void	operator-= (const zero)
	Subtraction assignment. More...
void	operator*= (const LagrangianSubField< scalar, PrimitiveField > &)
	Multiply assignment. More...
void	operator*= (const tmp< LagrangianSubField< scalar, PrimitiveField >> &)
	Multiply assignment. More...
void	operator*= (const dimensioned< scalar > &)
	Multiply assignment. More...
void	operator*= (const zero &)
	Multiply assignment. More...
void	operator/= (const LagrangianSubField< scalar, PrimitiveField > &)
	Division assignment. More...
void	operator/= (const tmp< LagrangianSubField< scalar, PrimitiveField >> &)
	Division assignment. More...
void	operator/= (const dimensioned< scalar > &)
	Division 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...

Friends
tmp< LagrangianSubField< Type > >	operator/ (const LagrangianCoeff< Type, false > &Su, const LagrangianSp< Type > &Sp)
	Divide an Su by an Sp. 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...

Detailed Description

template<class Type>
class Foam::LagrangianSp< Type >

Wrapper around LagrangianCoeff to specialise for the implicit coefficient. Trivial at present. The idea eventually is to make the vector implicit coefficient automatically build tensor coefficients as and when a model supplies tensor values.

Definition at line 68 of file LagrangianSp.H.

Constructor & Destructor Documentation

LagrangianSp() [1/3]

LagrangianSp	(	const LagrangianEqnBase &	eqn,
		const LagrangianSp< Type > &	Sp
	)

Construct as copy.

Definition at line 31 of file LagrangianSp.C.

LagrangianSp() [2/3]

LagrangianSp	(	const LagrangianEqnBase &	eqn,
		LagrangianSp< Type > &	Sp,
		const bool	reuse
	)

Construct as copy or reuse as specified.

Definition at line 42 of file LagrangianSp.C.

LagrangianSp() [3/3]

LagrangianSp

(

LagrangianSp< Type > &&

Sp

)

Move construct.

Definition at line 54 of file LagrangianSp.C.

Member Function Documentation

A()

Foam::tmp< Foam::LagrangianCoeff< Foam::scalar, true > > A

Return the scalar diagonal coefficient.

Definition at line 64 of file LagrangianSp.C.

H()

Foam::tmp< Foam::LagrangianCoeff< Foam::vector, false > > H

Return the scalar off-diagonal coefficients.

Definition at line 72 of file LagrangianSp.C.

Su() [1/2]

Foam::tmp< Foam::LagrangianCoeff< Foam::vector, false > > Su

Return the equivalent explicit coefficient.

Definition at line 84 of file LagrangianSp.C.

References Foam::fvc::Su().

Here is the call graph for this function:

Su() [2/2]

Foam::tmp< Foam::LagrangianCoeff< Type, false > > Su

(

const LagrangianEqn< Type > &

eqn

)

const

Return the equivalent explicit coefficient. Pass the equation.

explicitly so this can be used in the equation destructor when the reference held by the coeff classes might no longer be valid.

Definition at line 92 of file LagrangianSp.C.

References LagrangianEqn< Type >::psi(), Foam::fvm::S(), and Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

operator+=() [1/5]

void operator+=

(

const LagrangianSp< OtherType > &

Sp

)

Addition assignment.

Definition at line 108 of file LagrangianSp.C.

References Foam::fvc::Sp().

Here is the call graph for this function:

operator-=() [1/5]

void operator-=

(

const LagrangianSp< OtherType > &

Sp

)

Subtraction assignment.

Definition at line 116 of file LagrangianSp.C.

References Foam::fvc::Sp().

Here is the call graph for this function:

operator+=() [2/5]

void operator+=

(

const LagrangianSubField< scalar, PrimitiveField > &

S

)

Definition at line 58 of file LagrangianVectorSpTemplates.C.

References Foam::I, and Foam::fvm::S().

Here is the call graph for this function:

operator+=() [3/5]

void operator+=

(

const LagrangianSubField< tensor, PrimitiveField > &

S

)

Definition at line 75 of file LagrangianVectorSpTemplates.C.

References Foam::fvm::S().

Here is the call graph for this function:

operator+=() [4/5]

void operator+=

(

const tmp< LagrangianSubField< scalar, PrimitiveField >> &

tS

)

Definition at line 86 of file LagrangianVectorSpTemplates.C.

References Foam::I.

operator+=() [5/5]

void operator+=

(

const tmp< LagrangianSubField< tensor, PrimitiveField >> &

tS

)

Definition at line 103 of file LagrangianVectorSpTemplates.C.

operator-=() [2/5]

void operator-=

(

const LagrangianSubField< scalar, PrimitiveField > &

S

)

Definition at line 127 of file LagrangianVectorSpTemplates.C.

References Foam::I, and Foam::fvm::S().

Here is the call graph for this function:

operator-=() [3/5]

void operator-=

(

const LagrangianSubField< tensor, PrimitiveField > &

S

)

Definition at line 144 of file LagrangianVectorSpTemplates.C.

References Foam::fvm::S().

Here is the call graph for this function:

operator-=() [4/5]

void operator-=

(

const tmp< LagrangianSubField< scalar, PrimitiveField >> &

tS

)

Definition at line 155 of file LagrangianVectorSpTemplates.C.

References Foam::I.

operator-=() [5/5]

void operator-=

(

const tmp< LagrangianSubField< tensor, PrimitiveField >> &

tS

)

Definition at line 172 of file LagrangianVectorSpTemplates.C.

Friends And Related Function Documentation

operator/

tmp<LagrangianSubField<Type> > operator/ ( const LagrangianCoeff< Type, false > &  Su, const LagrangianSp< Type > &  Sp  )

friend

Divide an Su by an Sp.

---

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

• src/Lagrangian/Lagrangian/LagrangianEqn/LagrangianSp.H
• src/Lagrangian/Lagrangian/LagrangianEqn/LagrangianSp.C
• src/Lagrangian/Lagrangian/LagrangianEqn/LagrangianVectorSp.C
• src/Lagrangian/Lagrangian/LagrangianEqn/LagrangianVectorSpTemplates.C