Abstract base class for surface interpolation schemes. More...

Inheritance diagram for surfaceInterpolationScheme< Type >:

[legend]

Collaboration diagram for surfaceInterpolationScheme< Type >:

Public Member Functions
	TypeName ("surfaceInterpolationScheme")
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, surfaceInterpolationScheme, Mesh,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))

	declareRunTimeSelectionTable (tmp, surfaceInterpolationScheme, MeshFlux,(const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData),(mesh, faceFlux, schemeData))

	surfaceInterpolationScheme (const fvMesh &mesh)
	Construct from mesh. More...

	surfaceInterpolationScheme (const surfaceInterpolationScheme &)=delete
	Disallow default bitwise copy construction. More...

virtual	~surfaceInterpolationScheme ()
	Destructor. More...

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

virtual tmp< surfaceScalarField >	weights (const VolField< Type > &) const =0
	Return the interpolation weighting factors for the given field. More...

virtual bool	corrected () const
	Return true if this scheme uses an explicit correction. More...

virtual tmp< SurfaceField< Type > >	correction (const VolField< Type > &) const
	Return the explicit correction to the face-interpolate. More...

virtual tmp< SurfaceField< typename innerProduct< vector, Type >::type > >	dotInterpolate (const surfaceVectorField &Sf, const VolField< Type > &vf) const
	Return the face-interpolate of the given cell field. More...

tmp< SurfaceField< typename innerProduct< vector, Type >::type > >	dotInterpolate (const surfaceVectorField &Sf, const tmp< VolField< Type >> &) const
	Return the face-interpolate of the given tmp cell field. More...

virtual tmp< SurfaceField< Type > >	interpolate (const VolField< Type > &) const
	Return the face-interpolate of the given cell field. More...

tmp< SurfaceField< Type > >	interpolate (const tmp< VolField< Type >> &) const
	Return the face-interpolate of the given tmp cell field. More...

void	operator= (const surfaceInterpolationScheme &)=delete
	Disallow default bitwise assignment. More...

tmp< SurfaceField< typename innerProduct< vector, scalar >::type > >	dotInterpolate (const surfaceVectorField &Sf, const VolField< scalar > &) 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...

Static Public Member Functions
static tmp< surfaceInterpolationScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
	Return new tmp interpolation scheme. More...

static tmp< surfaceInterpolationScheme< Type > >	New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
	Return new tmp interpolation scheme. More...

static tmp< SurfaceField< Type > >	interpolate (const VolField< Type > &, const tmp< surfaceScalarField > &, const tmp< surfaceScalarField > &)
	Return the face-interpolate of the given cell field. More...

template<class SFType >
static tmp< SurfaceField< typename innerProduct< typename SFType::value_type, Type >::type > >	dotInterpolate (const SFType &Sf, const VolField< Type > &vf, const tmp< surfaceScalarField > &tlambdas)
	Return the face-interpolate of the given cell field. More...

static tmp< SurfaceField< Type > >	interpolate (const VolField< Type > &, const tmp< surfaceScalarField > &)
	Return the face-interpolate of the given cell field. 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::surfaceInterpolationScheme< Type >

Abstract base class for surface interpolation schemes.

Source files

Definition at line 55 of file surfaceInterpolationScheme.H.

Constructor & Destructor Documentation

◆ surfaceInterpolationScheme() [1/2]

surfaceInterpolationScheme ( const fvMesh & mesh )

inline

Construct from mesh.

Definition at line 102 of file surfaceInterpolationScheme.H.

◆ surfaceInterpolationScheme() [2/2]

surfaceInterpolationScheme ( const surfaceInterpolationScheme< Type > & )

delete

Disallow default bitwise copy construction.

◆ ~surfaceInterpolationScheme()

~surfaceInterpolationScheme

virtual

Destructor.

Definition at line 131 of file surfaceInterpolationScheme.C.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceInterpolationScheme< Type >" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable	(	tmp	,
		surfaceInterpolationScheme< Type >	,
		Mesh	,
		(const fvMesh &mesh, Istream &schemeData)	,
		(mesh, schemeData)
	)

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable	(	tmp	,
		surfaceInterpolationScheme< Type >	,
		MeshFlux	,
		(const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)	,
		(mesh, faceFlux, schemeData)
	)

◆ New() [1/2]

Foam::tmp< Foam::surfaceInterpolationScheme< Type > > New	(	const fvMesh &	mesh,
		Istream &	schemeData
	)

static

Return new tmp interpolation scheme.

Definition at line 36 of file surfaceInterpolationScheme.C.

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

Referenced by gaussGrad< Type >::gaussGrad(), laplacianScheme< Type, GType >::laplacianScheme(), and multivariateIndependentScheme< Type >::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New() [2/2]

Foam::tmp< Foam::surfaceInterpolationScheme< Type > > New	(	const fvMesh &	mesh,
		const surfaceScalarField &	faceFlux,
		Istream &	schemeData
	)

static

Return new tmp interpolation scheme.

Definition at line 82 of file surfaceInterpolationScheme.C.

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

Here is the call graph for this function:

◆ mesh()

const fvMesh& mesh ( ) const

inline

Return mesh reference.

Definition at line 137 of file surfaceInterpolationScheme.H.

Referenced by cellCoBlended< Type >::blendingFactor(), CoBlended< Type >::blendingFactor(), localBlended< Type >::blendingFactor(), skewCorrected< Type >::corrected(), CentredFitScheme< Type, Polynomial, Stencil >::correction(), cubic< Type >::correction(), localBlended< Type >::correction(), PureUpwindFitScheme< Type, Polynomial, Stencil >::correction(), skewCorrected< Type >::correction(), UpwindFitScheme< Type, Polynomial, Stencil >::correction(), localBlended< Type >::interpolate(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), blended< Type >::limiter(), upwind< Type >::limiter(), skewCorrected< Type >::skewCorrection(), clippedLinear< Type >::weights(), linear< Type >::weights(), LUST< Type >::weights(), midPoint< Type >::weights(), reverseLinear< Type >::weights(), blended< Type >::weights(), and localBlended< Type >::weights().

Here is the caller graph for this function:

◆ interpolate() [1/4]

Foam::tmp< Foam::SurfaceField< Type > > interpolate	(	const VolField< Type > &	vf,
		const tmp< surfaceScalarField > &	tlambdas,
		const tmp< surfaceScalarField > &	tys
	)

static

Return the face-interpolate of the given cell field.

with the given owner and neighbour weighting factors

Definition at line 139 of file surfaceInterpolationScheme.C.

Referenced by cubic< Type >::correction(), harmonic::interpolate(), Foam::linearInterpolate(), skewCorrected< Type >::skewCorrection(), and phaseSystem::solve().

Here is the caller graph for this function:

◆ dotInterpolate() [1/4]

static tmp< SurfaceField < typename innerProduct<typename SFType::value_type, Type>::type > > dotInterpolate	(	const SFType &	Sf,
		const VolField< Type > &	vf,
		const tmp< surfaceScalarField > &	tlambdas
	)

static

Return the face-interpolate of the given cell field.

with the given weighting factors dotted with given field Sf

◆ interpolate() [2/4]

Foam::tmp< Foam::SurfaceField< Type > > interpolate	(	const VolField< Type > &	vf,
		const tmp< surfaceScalarField > &	tlambdas
	)

static

Return the face-interpolate of the given cell field.

with the given weighting factors

Definition at line 307 of file surfaceInterpolationScheme.C.

References Foam::fvc::dotInterpolate().

Here is the call graph for this function:

◆ weights()

virtual tmp<surfaceScalarField> weights ( const VolField< Type > & ) const

pure virtual

◆ corrected()

virtual bool corrected ( ) const

inlinevirtual

Return true if this scheme uses an explicit correction.

Reimplemented in UpwindFitScheme< Type, Polynomial, Stencil >, skewCorrected< Type >, PureUpwindFitScheme< Type, Polynomial, Stencil >, pointLinear< Type >, phaseStabilised< Type >, outletStabilised< Type >, LUST< Type >, localBlended< Type >, linearUpwindV< Type >, linearUpwind< Type >, limiterBlended< Type >, fixedBlended< Type >, deferred< Type >, cubic< Type >, CoBlended< Type >, CentredFitScheme< Type, Polynomial, Stencil >, cellCoBlended< Type >, and limitWith< Type >.

Definition at line 186 of file surfaceInterpolationScheme.H.

◆ correction()

virtual tmp<SurfaceField<Type> > correction ( const VolField< Type > & ) const

inlinevirtual

Return the explicit correction to the face-interpolate.

for the given field

Reimplemented in UpwindFitScheme< Type, Polynomial, Stencil >, skewCorrected< Type >, PureUpwindFitScheme< Type, Polynomial, Stencil >, pointLinear< Type >, phaseStabilised< Type >, outletStabilised< Type >, LUST< Type >, localBlended< Type >, limiterBlended< Type >, fixedBlended< Type >, deferred< Type >, cubic< Type >, CoBlended< Type >, CentredFitScheme< Type, Polynomial, Stencil >, cellCoBlended< Type >, limitWith< Type >, linearUpwindV< Type >, and linearUpwind< Type >.

Definition at line 194 of file surfaceInterpolationScheme.H.

◆ dotInterpolate() [2/4]

virtual tmp<SurfaceField<typename innerProduct<vector, Type>::type> > dotInterpolate	(	const surfaceVectorField &	Sf,
		const VolField< Type > &	vf
	)		const

virtual

Return the face-interpolate of the given cell field.

with explicit correction dotted with given field Sf

◆ dotInterpolate() [3/4]

tmp<SurfaceField<typename innerProduct<vector, Type>::type> > dotInterpolate	(	const surfaceVectorField &	Sf,
		const tmp< VolField< Type >> &
	)		const

Return the face-interpolate of the given tmp cell field.

with explicit correction dotted with given field Sf

◆ interpolate() [3/4]

Foam::tmp< Foam::SurfaceField< Type > > interpolate ( const VolField< Type > & vf ) const

virtual

Return the face-interpolate of the given cell field.

with explicit correction

Reimplemented in localMin< Type >, localMax< Type >, localBlended< Type >, limiterBlended< Type >, fixedBlended< Type >, CoBlended< Type >, and cellCoBlended< Type >.

Definition at line 380 of file surfaceInterpolationScheme.C.

References Foam::correction(), Foam::endl(), InfoInFunction, Foam::fvc::interpolate(), IOobject::name(), and tmp< T >::ref().

Here is the call graph for this function:

◆ interpolate() [4/4]

Foam::tmp< Foam::SurfaceField< Type > > interpolate ( const tmp< VolField< Type >> & tvf ) const

Return the face-interpolate of the given tmp cell field.

with explicit correction

Definition at line 409 of file surfaceInterpolationScheme.C.

References Foam::fvc::interpolate().

Here is the call graph for this function:

◆ operator=()

void operator= ( const surfaceInterpolationScheme< Type > & )

delete

Disallow default bitwise assignment.

◆ dotInterpolate() [4/4]

tmp< SurfaceField< typename innerProduct< vector, scalar >::type > > dotInterpolate	(	const surfaceVectorField &	Sf,
		const VolField< scalar > &
	)		const

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

src/finiteVolume/interpolation/surfaceInterpolation/surfaceInterpolationScheme/surfaceInterpolationScheme.H
src/finiteVolume/interpolation/surfaceInterpolation/surfaceInterpolationScheme/surfaceInterpolationScheme.C

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::surfaceInterpolationScheme< Type >

Constructor & Destructor Documentation

◆ surfaceInterpolationScheme() [1/2]

◆ surfaceInterpolationScheme() [2/2]

◆ ~surfaceInterpolationScheme()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ New() [1/2]

◆ New() [2/2]

◆ mesh()

◆ interpolate() [1/4]

◆ dotInterpolate() [1/4]

◆ interpolate() [2/4]

◆ weights()

◆ corrected()

◆ correction()

◆ dotInterpolate() [2/4]

◆ dotInterpolate() [3/4]

◆ interpolate() [3/4]

◆ interpolate() [4/4]

◆ operator=()

◆ dotInterpolate() [4/4]

template<class Type>
class Foam::surfaceInterpolationScheme< Type >