SpScheme< Type, SpType > Class Template Reference

Abstract base class for Lagrangian Sp schemes. More...

Inheritance diagram for SpScheme< Type, SpType >:

Collaboration diagram for SpScheme< Type, SpType >:

Public Member Functions
	TypeName ("SpScheme")
	Runtime type information. More...
	declareRunTimeSelectionTable (tmp, SpScheme, Istream,(const LagrangianMesh &mesh, Istream &is),(mesh, is))
	Declare run-time constructor selection tables. More...
	SpScheme (const LagrangianMesh &mesh)
	Construct from a mesh. More...
	SpScheme (const LagrangianMesh &mesh, Istream &)
	Construct from a mesh and a stream. More...
	SpScheme (const SpScheme &)=delete
	Disallow default bitwise copy construction. More...
virtual	~SpScheme ()
	Destructor. More...
const LagrangianMesh &	mesh () const
	Return mesh reference. More...
virtual tmp< LagrangianEqn< Type > >	LagrangianmSp (const LagrangianSubField< SpType > &Sp, const LagrangianSubSubField< Type > &psi)=0
	Return the source matrix. More...
void	operator= (const SpScheme &)=delete
	Disallow default bitwise 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...

Static Public Member Functions
static tmp< SpScheme< Type, SpType > >	New (const LagrangianMesh &mesh, Istream &is)
	Return a pointer to a new SpScheme. More...

Static Protected Member Functions
static tmp< LagrangianSubField< Type > >	inner (const LagrangianSubScalarField &Sp, const LagrangianSubSubField< Type > &psi)
	Generate the inner product of a scalar coefficient with a field. More...
static tmp< LagrangianSubField< typename innerProduct< tensor, Type >::type > >	inner (const LagrangianSubTensorField &Sp, const LagrangianSubSubField< Type > &psi)
	Generate the inner product of a tensor coefficient with a field. More...

Protected Attributes
const LagrangianMesh &	mesh_
	Reference to the mesh. 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 SpType>
class Foam::Lagrangian::SpScheme< Type, SpType >

Abstract base class for Lagrangian Sp schemes.

Source files

• LagrangianSpScheme.H
• LagrangianSpScheme.C
• LagrangianSpSchemes.C

Definition at line 62 of file LagrangianSpScheme.H.

Constructor & Destructor Documentation

SpScheme() [1/3]

SpScheme ( const LagrangianMesh &  mesh )

inline

Construct from a mesh.

Definition at line 117 of file LagrangianSpScheme.H.

SpScheme() [2/3]

SpScheme ( const LagrangianMesh &  mesh, Istream &    )

inline

Construct from a mesh and a stream.

Definition at line 123 of file LagrangianSpScheme.H.

SpScheme() [3/3]

SpScheme ( const SpScheme< Type, SpType > &  )

delete

Disallow default bitwise copy construction.

~SpScheme()

~SpScheme

virtual

Destructor.

Definition at line 101 of file LagrangianSpScheme.C.

Member Function Documentation

inner() [1/2]

Foam::tmp< Foam::LagrangianSubField< Type > > inner ( const LagrangianSubScalarField &  Sp, const LagrangianSubSubField< Type > &  psi  )

staticprotected

Generate the inner product of a scalar coefficient with a field.

Definition at line 33 of file LagrangianSpScheme.C.

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

Here is the call graph for this function:

inner() [2/2]

static tmp< LagrangianSubField < typename innerProduct<tensor, Type>::type > > inner ( const LagrangianSubTensorField &  Sp, const LagrangianSubSubField< Type > &  psi  )

staticprotected

Generate the inner product of a tensor coefficient with a field.

TypeName()

TypeName

(

"SpScheme< Type, SpType >"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	tmp	,
		SpScheme< Type, SpType >	,
		Istream	,
		(const LagrangianMesh &mesh, Istream &is)	,
		(mesh, is)
	)

Declare run-time constructor selection tables.

New()

Foam::tmp< Foam::Lagrangian::SpScheme< Type, SpType > > New ( const LagrangianMesh &  mesh, Istream &  is  )

static

Return a pointer to a new SpScheme.

Definition at line 65 of file LagrangianSpScheme.C.

References Foam::endl(), IOstream::eof(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, mesh, and Foam::nl.

Here is the call graph for this function:

mesh()

const LagrangianMesh& mesh ( ) const

inline

Return mesh reference.

Definition at line 149 of file LagrangianSpScheme.H.

References SpScheme< Type, SpType >::mesh_.

LagrangianmSp()

virtual tmp<LagrangianEqn<Type> > LagrangianmSp ( const LagrangianSubField< SpType > &  Sp, const LagrangianSubSubField< Type > &  psi  )

pure virtual

Return the source matrix.

Implemented in implicit< Type, SpType >, and Explicit< Type, SpType >.

operator=()

void operator= ( const SpScheme< Type, SpType > &  )

delete

Disallow default bitwise assignment.

Member Data Documentation

mesh_

const LagrangianMesh& mesh_

protected

Reference to the mesh.

Definition at line 71 of file LagrangianSpScheme.H.

Referenced by SpScheme< Type, SpType >::mesh().

---

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

• src/Lagrangian/Lagrangian/Lagrangian/LagrangianSpSchemes/LagrangianSpScheme/LagrangianSpScheme.H
• src/Lagrangian/Lagrangian/Lagrangian/LagrangianSpSchemes/LagrangianSpScheme/LagrangianSpScheme.C