Abstract base class for interpolation. More...

Inheritance diagram for interpolation< Type >:

[legend]

Collaboration diagram for interpolation< Type >:

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

	declareRunTimeSelectionTable (autoPtr, interpolation, dictionary,(const VolField< Type > &psi),(psi))

	interpolation (const VolField< Type > &psi)
	Construct from components. More...

	interpolation (const interpolation< Type > &i)
	Copy constructor. More...

virtual autoPtr< interpolation< Type > >	clone () const =0
	Clone. More...

virtual	~interpolation ()
	Destructor. More...

const VolField< Type > &	psi () const
	Return the field to be interpolated. More...

virtual Type	interpolate (const vector &position, const label celli, const label facei=-1) const =0
	Interpolate field to the given point in the given cell. More...

virtual tmp< Field< Type > >	interpolate (const vectorField &position, const labelList &celli, const labelList &facei=NullObjectRef< labelList >()) const =0
	As above, but for a field. More...

virtual Type	interpolate (const barycentric &coordinates, const tetIndices &tetIs, const label facei=-1) const
	Interpolate field to the given coordinates in the tetrahedron. More...

virtual tmp< Field< Type > >	interpolate (const Field< barycentric > &coordinates, const labelList &celli, const labelList &tetFacei, const labelList &tetPti, const labelList &facei=NullObjectRef< labelList >()) const =0
	As above, but for a field. More...

Static Public Member Functions
static autoPtr< interpolation< Type > >	New (const word &interpolationType, const VolField< Type > &psi)
	Return a reference to the specified interpolation scheme. More...

static autoPtr< interpolation< Type > >	New (const dictionary &interpolationSchemes, const VolField< Type > &psi)
	Return a reference to the selected interpolation scheme. More...

Protected Attributes
const VolField< Type > &	psi_
	The vol field to interpolate. More...

const polyMesh &	mesh_
	Reference to the mesh. More...

Detailed Description

template<class Type>
class Foam::interpolation< Type >

Abstract base class for interpolation.

Definition at line 54 of file interpolation.H.

Constructor & Destructor Documentation

◆ interpolation() [1/2]

interpolation ( const VolField< Type > & psi )

Construct from components.

Definition at line 34 of file interpolation.C.

◆ interpolation() [2/2]

interpolation ( const interpolation< Type > & i )

Copy constructor.

Definition at line 45 of file interpolation.C.

◆ ~interpolation()

virtual ~interpolation ( )

inlinevirtual

Destructor.

Definition at line 121 of file interpolation.H.

Member Function Documentation

◆ TypeName()

TypeName ( "interpolation< Type >" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		interpolation< Type >	,
		dictionary	,
		(const VolField< Type > &psi)	,
		(psi)
	)

◆ New() [1/2]

Foam::autoPtr< Foam::interpolation< Type > > New	(	const word &	interpolationType,
		const VolField< Type > &	psi
	)

static

Return a reference to the specified interpolation scheme.

Definition at line 55 of file interpolation.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::name(), Foam::nl, and psi.

Referenced by ParamagneticForce< CloudType >::cacheFields(), and streamlines::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New() [2/2]

Foam::autoPtr< Foam::interpolation< Type > > New	(	const dictionary &	interpolationSchemes,
		const VolField< Type > &	psi
	)

static

Return a reference to the selected interpolation scheme.

Definition at line 79 of file interpolation.C.

References dictionary::lookup(), IOobject::name(), Foam::New(), and psi.

Here is the call graph for this function:

◆ clone()

virtual autoPtr<interpolation<Type> > clone ( ) const

pure virtual

Clone.

Implemented in interpolationPointMVC< Type >, interpolationCellPointWallModified< Type >, interpolationCellPointFace< Type >, interpolationCellPoint< Type >, interpolationCellPoint< scalar >, interpolationCellPoint< Foam::Vector >, interpolationCellPatchConstrained< Type >, and interpolationCell< Type >.

◆ psi()

const VolField<Type>& psi ( ) const

inline

Return the field to be interpolated.

Definition at line 128 of file interpolation.H.

References interpolation< Type >::psi_.

Referenced by interpolationCellPoint< Type >::interpolationCellPoint().

Here is the caller graph for this function:

◆ interpolate() [1/4]

virtual Type interpolate	(	const vector &	position,
		const label	celli,
		const label	facei = `-1`
	)		const

pure virtual

Interpolate field to the given point in the given cell.

Implemented in interpolationPointMVC< Type >, interpolationCellPointFace< Type >, interpolationCellPoint< Type >, interpolationCellPoint< scalar >, interpolationCellPoint< Foam::Vector >, interpolationCellPatchConstrained< Type >, and interpolationCell< Type >.

Referenced by ParamagneticForce< CloudType >::calcNonCoupled(), sampledIsoSurfaceSurface::interpolateField(), patch::interpolateField(), patchInternalField::interpolateField(), thresholdCellFaces::interpolateField(), triSurface::interpolateField(), sampledSets::sampleLocalType(), and mappedInternalValueFvPatchField< Type >::updateCoeffs().

Here is the caller graph for this function:

◆ interpolate() [2/4]

virtual tmp<Field<Type> > interpolate	(	const vectorField &	position,
		const labelList &	celli,
		const labelList &	facei = `NullObjectRef< labelList >()`
	)		const

pure virtual

As above, but for a field.

Implemented in fieldInterpolation< Type, InterpolationType >, fieldInterpolation< Type, interpolationPointMVC< Type > >, fieldInterpolation< Type, interpolationCellPatchConstrained< Type > >, fieldInterpolation< Type, interpolationCellPointFace< Type > >, fieldInterpolation< Type, interpolationCellPoint< Type > >, and fieldInterpolation< Type, interpolationCell< Type > >.

◆ interpolate() [3/4]

Type interpolate	(	const barycentric &	coordinates,
		const tetIndices &	tetIs,
		const label	facei = `-1`
	)		const

virtual

Interpolate field to the given coordinates in the tetrahedron.

defined by the given indices. Calls interpolate function above here except where overridden by derived interpolation types.

Reimplemented in interpolationCellPoint< Type >, interpolationCellPoint< scalar >, interpolationCellPoint< Foam::Vector >, interpolationCellPatchConstrained< Type >, and interpolationCell< Type >.

Definition at line 92 of file interpolation.C.

◆ interpolate() [4/4]

virtual tmp<Field<Type> > interpolate	(	const Field< barycentric > &	coordinates,
		const labelList &	celli,
		const labelList &	tetFacei,
		const labelList &	tetPti,
		const labelList &	facei = `NullObjectRef< labelList >()`
	)		const

pure virtual

As above, but for a field.

Implemented in fieldInterpolation< Type, InterpolationType >, fieldInterpolation< Type, interpolationPointMVC< Type > >, fieldInterpolation< Type, interpolationCellPatchConstrained< Type > >, fieldInterpolation< Type, interpolationCellPointFace< Type > >, fieldInterpolation< Type, interpolationCellPoint< Type > >, and fieldInterpolation< Type, interpolationCell< Type > >.

Member Data Documentation

◆ psi_

const VolField<Type>& psi_

protected

The vol field to interpolate.

Definition at line 61 of file interpolation.H.

Referenced by interpolation< Type >::psi().

◆ mesh_

const polyMesh& mesh_

protected

Reference to the mesh.

Definition at line 64 of file interpolation.H.

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

src/finiteVolume/interpolation/interpolation/interpolation/interpolation.H
src/finiteVolume/interpolation/interpolation/interpolation/interpolation.C

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

template<class Type> class Foam::interpolation< Type >

Constructor & Destructor Documentation

◆ interpolation() [1/2]

◆ interpolation() [2/2]

◆ ~interpolation()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New() [1/2]

◆ New() [2/2]

◆ clone()

◆ psi()

◆ interpolate() [1/4]

◆ interpolate() [2/4]

◆ interpolate() [3/4]

◆ interpolate() [4/4]

Member Data Documentation

◆ psi_

◆ mesh_

template<class Type>
class Foam::interpolation< Type >