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

Inheritance diagram for LagrangianCoeff< Type, Implicit >:

[legend]

Collaboration diagram for LagrangianCoeff< Type, Implicit >:

Public Member Functions
	LagrangianCoeff (const LagrangianEqnBase &eqn)
	Construct empty. More...

	LagrangianCoeff (const LagrangianEqnBase &eqn, const LagrangianCoeff< Type, Implicit > &coeff)
	Construct as copy. More...

	LagrangianCoeff (const LagrangianEqnBase &eqn, LagrangianCoeff< Type, Implicit > &coeff, const bool reuse)
	Construct as copy or reuse as specified. More...

	LagrangianCoeff (LagrangianCoeff< Type, Implicit > &&coeff)
	Move construct. More...

template<template< class > class PrimitiveField>
	LagrangianCoeff (const LagrangianEqnBase &eqn, const LagrangianSubField< Type, PrimitiveField > &)
	Construct from a field. More...

template<template< class > class PrimitiveField>
	LagrangianCoeff (const LagrangianEqnBase &eqn, const tmp< LagrangianSubField< Type, 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< Type > &	S () const
	Access the coefficient. More...

void	negate ()
	In-place negation. More...

template<template< class > class PrimitiveField>
void	operator+= (const LagrangianSubField< Type, PrimitiveField > &)
	Addition assignment. More...

template<template< class > class PrimitiveField>
void	operator+= (const tmp< LagrangianSubField< Type, PrimitiveField >> &)
	Addition assignment. More...

void	operator+= (const LagrangianCoeff< Type, Implicit > &)
	Addition assignment. More...

template<class OtherType >
void	operator+= (const LagrangianCoeff< OtherType, Implicit > &)
	Addition assignment. More...

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

void	operator+= (const zero)
	Addition assignment. More...

template<template< class > class PrimitiveField>
void	operator-= (const LagrangianSubField< Type, PrimitiveField > &)
	Subtraction assignment. More...

template<template< class > class PrimitiveField>
void	operator-= (const tmp< LagrangianSubField< Type, PrimitiveField >> &)
	Subtraction assignment. More...

void	operator-= (const LagrangianCoeff< Type, Implicit > &)
	Subtraction assignment. More...

template<class OtherType >
void	operator-= (const LagrangianCoeff< OtherType, Implicit > &)
	Addition assignment. More...

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

void	operator-= (const zero)
	Subtraction assignment. More...

template<template< class > class PrimitiveField>
void	operator*= (const LagrangianSubField< scalar, PrimitiveField > &)
	Multiply assignment. More...

template<template< class > class PrimitiveField>
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...

template<template< class > class PrimitiveField>
void	operator/= (const LagrangianSubField< scalar, PrimitiveField > &)
	Division assignment. More...

template<template< class > class PrimitiveField>
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...

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, bool Implicit>
class Foam::LagrangianCoeff< Type, Implicit >

Class to store a coefficient of a Lagrangian equation.

Source files

Definition at line 51 of file LagrangianCoeff.H.

Constructor & Destructor Documentation

◆ LagrangianCoeff() [1/6]

LagrangianCoeff ( const LagrangianEqnBase & eqn )

Construct empty.

Definition at line 58 of file LagrangianCoeff.C.

◆ LagrangianCoeff() [2/6]

LagrangianCoeff	(	const LagrangianEqnBase &	eqn,
		const LagrangianCoeff< Type, Implicit > &	coeff
	)

Construct as copy.

Definition at line 68 of file LagrangianCoeff.C.

◆ LagrangianCoeff() [3/6]

LagrangianCoeff	(	const LagrangianEqnBase &	eqn,
		LagrangianCoeff< Type, Implicit > &	coeff,
		const bool	reuse
	)

Construct as copy or reuse as specified.

Definition at line 81 of file LagrangianCoeff.C.

◆ LagrangianCoeff() [4/6]

LagrangianCoeff ( LagrangianCoeff< Type, Implicit > && coeff )

Move construct.

Definition at line 94 of file LagrangianCoeff.C.

◆ LagrangianCoeff() [5/6]

LagrangianCoeff	(	const LagrangianEqnBase &	eqn,
		const LagrangianSubField< Type, PrimitiveField > &	S
	)

Construct from a field.

Definition at line 107 of file LagrangianCoeff.C.

◆ LagrangianCoeff() [6/6]

LagrangianCoeff	(	const LagrangianEqnBase &	eqn,
		const tmp< LagrangianSubField< Type, PrimitiveField >> &	tS
	)

Construct from a tmp field.

Definition at line 120 of file LagrangianCoeff.C.

Member Function Documentation

◆ eqn()

const Foam::LagrangianEqnBase & eqn

Access the equation.

Definition at line 135 of file LagrangianCoeff.C.

◆ valid()

bool valid

Determine whether this coefficient has values or not.

Definition at line 142 of file LagrangianCoeff.C.

◆ S()

const Foam::LagrangianSubField< Type > & S

Access the coefficient.

Definition at line 150 of file LagrangianCoeff.C.

◆ negate()

void negate

In-place negation.

Definition at line 157 of file LagrangianCoeff.C.

References Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

◆ operator+=() [1/6]

void operator+= ( const LagrangianSubField< Type, PrimitiveField > & S )

Addition assignment.

Definition at line 167 of file LagrangianCoeff.C.

◆ operator+=() [2/6]

void operator+= ( const tmp< LagrangianSubField< Type, PrimitiveField >> & tS )

Addition assignment.

Definition at line 179 of file LagrangianCoeff.C.

◆ operator+=() [3/6]

void operator+= ( const LagrangianCoeff< Type, Implicit > & )

Addition assignment.

◆ operator+=() [4/6]

void operator+= ( const LagrangianCoeff< OtherType, Implicit > & coeff )

Addition assignment.

Definition at line 202 of file LagrangianCoeff.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and LagrangianEqnBase::name().

Here is the call graph for this function:

◆ operator+=() [5/6]

void operator+= ( const dimensioned< Type > & dt )

Addition assignment.

Definition at line 218 of file LagrangianCoeff.C.

◆ operator+=() [6/6]

void operator+= ( const zero )

Addition assignment.

Definition at line 229 of file LagrangianCoeff.C.

◆ operator-=() [1/6]

void operator-= ( const LagrangianSubField< Type, PrimitiveField > & S )

Subtraction assignment.

Definition at line 235 of file LagrangianCoeff.C.

References Foam::fvm::S().

Here is the call graph for this function:

◆ operator-=() [2/6]

void operator-= ( const tmp< LagrangianSubField< Type, PrimitiveField >> & tS )

Subtraction assignment.

Definition at line 247 of file LagrangianCoeff.C.

References Foam::operator-=().

Here is the call graph for this function:

◆ operator-=() [3/6]

void operator-= ( const LagrangianCoeff< Type, Implicit > & )

Subtraction assignment.

◆ operator-=() [4/6]

void operator-= ( const LagrangianCoeff< OtherType, Implicit > & coeff )

Addition assignment.

Definition at line 270 of file LagrangianCoeff.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and LagrangianEqnBase::name().

Here is the call graph for this function:

◆ operator-=() [5/6]

void operator-= ( const dimensioned< Type > & dt )

Subtraction assignment.

Definition at line 286 of file LagrangianCoeff.C.

◆ operator-=() [6/6]

void operator-= ( const zero )

Subtraction assignment.

Definition at line 297 of file LagrangianCoeff.C.

◆ operator*=() [1/4]

void operator*= ( const LagrangianSubField< scalar, PrimitiveField > & S )

Multiply assignment.

Definition at line 303 of file LagrangianCoeff.C.

References Foam::fvm::S(), and Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

◆ operator*=() [2/4]

void operator*= ( const tmp< LagrangianSubField< scalar, PrimitiveField >> & tS )

Multiply assignment.

Definition at line 315 of file LagrangianCoeff.C.

References Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

◆ operator*=() [3/4]

void operator*= ( const dimensioned< scalar > & dt )

Multiply assignment.

Definition at line 327 of file LagrangianCoeff.C.

References Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

◆ operator*=() [4/4]

void operator*= ( const zero & )

Multiply assignment.

Definition at line 338 of file LagrangianCoeff.C.

◆ operator/=() [1/3]

void operator/= ( const LagrangianSubField< scalar, PrimitiveField > & S )

Division assignment.

Definition at line 346 of file LagrangianCoeff.C.

References Foam::fvm::S(), and Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

◆ operator/=() [2/3]

void operator/= ( const tmp< LagrangianSubField< scalar, PrimitiveField >> & tS )

Division assignment.

Definition at line 358 of file LagrangianCoeff.C.

References Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

◆ operator/=() [3/3]

void operator/= ( const dimensioned< scalar > & dt )

Division assignment.

Definition at line 370 of file LagrangianCoeff.C.

References Foam::blendedInterfacialModel::valid().

Here is the call graph for this function:

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

src/Lagrangian/Lagrangian/LagrangianEqn/LagrangianCoeff.H
src/Lagrangian/Lagrangian/LagrangianEqn/LagrangianCoeff.C

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ LagrangianCoeff() [1/6]

◆ LagrangianCoeff() [2/6]

◆ LagrangianCoeff() [3/6]

◆ LagrangianCoeff() [4/6]

◆ LagrangianCoeff() [5/6]

◆ LagrangianCoeff() [6/6]

Member Function Documentation

◆ eqn()

◆ valid()

◆ S()

◆ negate()

◆ operator+=() [1/6]

◆ operator+=() [2/6]

◆ operator+=() [3/6]

◆ operator+=() [4/6]

◆ operator+=() [5/6]

◆ operator+=() [6/6]

◆ operator-=() [1/6]

◆ operator-=() [2/6]

◆ operator-=() [3/6]

◆ operator-=() [4/6]

◆ operator-=() [5/6]

◆ operator-=() [6/6]

◆ operator*=() [1/4]

◆ operator*=() [2/4]

◆ operator*=() [3/4]

◆ operator*=() [4/4]

◆ operator/=() [1/3]

◆ operator/=() [2/3]

◆ operator/=() [3/3]

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