LagrangianSp< vector > Class Reference
Inheritance diagram for LagrangianSp< vector >:
Collaboration diagram for LagrangianSp< vector >:

Public Member Functions

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

Definition at line 143 of file LagrangianSp.H.

Constructor & Destructor Documentation

◆ LagrangianSp() [1/6]

LagrangianSp ( const LagrangianEqn< vector > &  eqn)

Construct from a reference to the equation.

◆ LagrangianSp() [2/6]

LagrangianSp ( const LagrangianSp< vector > &  coeff)

Construct as copy.

◆ LagrangianSp() [3/6]

LagrangianSp ( LagrangianSp< vector > &  coeff,
const bool  reuse 
)

Construct as copy or reuse as specified.

◆ LagrangianSp() [4/6]

LagrangianSp ( LagrangianSp< vector > &&  coeff)

Move construct.

◆ LagrangianSp() [5/6]

LagrangianSp ( const LagrangianEqnBase eqn,
const LagrangianSubField< scalar, PrimitiveField > &   
)

Construct from a field.

◆ LagrangianSp() [6/6]

LagrangianSp ( const LagrangianEqnBase eqn,
const tmp< LagrangianSubField< scalar, PrimitiveField >> &   
)

Construct from a tmp field.

Member Function Documentation

◆ eqn()

const LagrangianEqnBase& eqn ( ) const

Access the equation.

◆ valid()

bool valid ( ) const

Determine whether this coefficient has values or not.

◆ negate()

void negate ( )

In-place negation.

◆ A()

tmp<LagrangianCoeff<scalar, true> > A ( ) const

Return the scalar diagonal coefficient.

◆ H()

tmp<LagrangianCoeff<vector, false> > H ( ) const

Return the scalar off-diagonal coefficients.

◆ Su() [1/2]

tmp<LagrangianCoeff<vector, false> > Su ( ) const

Return the equivalent explicit coefficient.

◆ Su() [2/2]

tmp<LagrangianCoeff<vector, false> > Su ( const LagrangianEqn< vector > &  ) 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.

◆ operator+=() [1/10]

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

Addition assignment.

◆ operator+=() [2/10]

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

Addition assignment.

◆ operator+=() [3/10]

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

Addition assignment.

◆ operator+=() [4/10]

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

Addition assignment.

◆ operator+=() [5/10]

void operator+= ( const LagrangianCoeff< scalar, true > &  coeff)

Addition assignment.

◆ operator+=() [6/10]

void operator+= ( const LagrangianCoeff< tensor, true > &  coeff)

Addition assignment.

◆ operator+=() [7/10]

void operator+= ( const LagrangianSp< vector > &  Sp)

Addition assignment.

◆ operator+=() [8/10]

void operator+= ( const dimensioned< scalar > &  )

Addition assignment.

◆ operator+=() [9/10]

void operator+= ( const dimensioned< tensor > &  )

Addition assignment.

◆ operator+=() [10/10]

void operator+= ( const  zero)

Addition assignment.

◆ operator-=() [1/10]

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

Subtraction assignment.

◆ operator-=() [2/10]

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

Subtraction assignment.

◆ operator-=() [3/10]

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

Subtraction assignment.

◆ operator-=() [4/10]

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

Subtraction assignment.

◆ operator-=() [5/10]

void operator-= ( const LagrangianCoeff< scalar, true > &  coeff)

Addition assignment.

◆ operator-=() [6/10]

void operator-= ( const LagrangianCoeff< tensor, true > &  coeff)

Addition assignment.

◆ operator-=() [7/10]

void operator-= ( const LagrangianSp< vector > &  Sp)

Subtraction assignment.

◆ operator-=() [8/10]

void operator-= ( const dimensioned< scalar > &  )

Subtraction assignment.

◆ operator-=() [9/10]

void operator-= ( const dimensioned< tensor > &  )

Subtraction assignment.

◆ operator-=() [10/10]

void operator-= ( const  zero)

Subtraction assignment.

◆ operator*=() [1/3]

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

Multiply assignment.

◆ operator*=() [2/3]

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

Multiply assignment.

◆ operator*=() [3/3]

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

Multiply assignment.

◆ operator/=() [1/3]

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

Division assignment.

◆ operator/=() [2/3]

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

Division assignment.

◆ operator/=() [3/3]

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

Division assignment.

Friends And Related Function Documentation

◆ operator/

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

Divide an Su by an Sp.


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