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...

virtual	~surfaceInterpolationScheme ()
	Destructor. More...

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

virtual tmp< surfaceScalarField >	weights (const GeometricField< Type, fvPatchField, volMesh > &) 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< GeometricField< Type, fvsPatchField, surfaceMesh > >	correction (const GeometricField< Type, fvPatchField, volMesh > &) const
	Return the explicit correction to the face-interpolate. More...

virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &) const
	Return the face-interpolate of the given cell field. More...

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const tmp< GeometricField< Type, fvPatchField, volMesh > > &) const
	Return the face-interpolate of the given tmp cell field. More...

Public Member Functions inherited from refCount
	refCount ()
	Construct null with zero count. More...

int	count () const
	Return the reference count. More...

bool	okToDelete () const
	Return true if the reference count is zero. More...

void	resetRefCount ()
	Reset the reference count to 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...

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< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &, const tmp< surfaceScalarField > &)
	Return the face-interpolate of the given cell field. More...

static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &)
	Return the face-interpolate of the given cell field. More...

Private Member Functions
	surfaceInterpolationScheme (const surfaceInterpolationScheme &)
	Disallow copy construct. More...

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

Private Attributes
const fvMesh &	mesh_
	Hold reference to mesh. 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 surfaceInterpolationScheme< Type > & )

private

Disallow copy construct.

◆ surfaceInterpolationScheme() [2/2]

surfaceInterpolationScheme ( const fvMesh & mesh )

inline

Construct from mesh.

Definition at line 111 of file surfaceInterpolationScheme.H.

◆ ~surfaceInterpolationScheme()

~surfaceInterpolationScheme

virtual

Destructor.

Definition at line 145 of file surfaceInterpolationScheme.C.

Member Function Documentation

◆ operator=()

void operator= ( const surfaceInterpolationScheme< Type > & )

private

Disallow default bitwise assignment.

◆ 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]

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

static

Return new tmp interpolation scheme.

Definition at line 44 of file surfaceInterpolationScheme.C.

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

Here is the caller graph for this function:

◆ New() [2/2]

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

static

Return new tmp interpolation scheme.

Definition at line 94 of file surfaceInterpolationScheme.C.

◆ mesh()

const fvMesh& mesh ( ) const

inline

Return mesh reference.

Definition at line 142 of file surfaceInterpolationScheme.H.

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

Here is the caller graph for this function:

◆ interpolate() [1/4]

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate	(	const GeometricField< Type, fvPatchField, volMesh > &	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 weigting factors

with the given owner and neighbour weighting factors

Definition at line 156 of file surfaceInterpolationScheme.C.

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

Here is the caller graph for this function:

◆ interpolate() [2/4]

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate	(	const GeometricField< Type, fvPatchField, volMesh > &	vf,
		const tmp< surfaceScalarField > &	tlambdas
	)

static

Return the face-interpolate of the given cell field.

with the given weighting factors

Definition at line 242 of file surfaceInterpolationScheme.C.

◆ weights()

virtual tmp<surfaceScalarField> weights ( const GeometricField< Type, fvPatchField, volMesh > & ) const

pure virtual

◆ corrected()

virtual bool corrected ( ) const

inlinevirtual

Return true if this scheme uses an explicit correction.

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

Definition at line 175 of file surfaceInterpolationScheme.H.

◆ correction()

virtual tmp<GeometricField<Type, fvsPatchField, surfaceMesh> > correction ( const GeometricField< Type, fvPatchField, volMesh > & ) const

inlinevirtual

Return the explicit correction to the face-interpolate.

for the given field

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

Definition at line 183 of file surfaceInterpolationScheme.H.

◆ interpolate() [3/4]

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate ( const GeometricField< Type, fvPatchField, volMesh > & vf ) const

virtual

Return the face-interpolate of the given cell field.

with explicit correction

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

Definition at line 321 of file surfaceInterpolationScheme.C.

◆ interpolate() [4/4]

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate ( const tmp< GeometricField< Type, fvPatchField, volMesh > > & tvf ) const

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

Return the face-interpolate of the given cell field.

with explicit correction

Definition at line 353 of file surfaceInterpolationScheme.C.

Field Documentation

◆ mesh_

const fvMesh& mesh_

private

Hold reference to mesh.

Definition at line 62 of file surfaceInterpolationScheme.H.

Referenced by outletStabilised< Type >::correction(), surfaceInterpolationScheme< scalar >::mesh(), and outletStabilised< Type >::weights().

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

Private Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ surfaceInterpolationScheme() [1/2]

◆ surfaceInterpolationScheme() [2/2]

◆ ~surfaceInterpolationScheme()

Member Function Documentation

◆ operator=()

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ New() [1/2]

◆ New() [2/2]

◆ mesh()

◆ interpolate() [1/4]

◆ interpolate() [2/4]

◆ weights()

◆ corrected()

◆ correction()

◆ interpolate() [3/4]

◆ interpolate() [4/4]

Field Documentation

◆ mesh_

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