Abstract base class for interpolation. More...

Inheritance diagram for interpolation< Type >:

[legend]

Collaboration diagram for interpolation< Type >:

Public Member Functions
virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, interpolation, dictionary,(const GeometricField< Type, fvPatchField, volMesh > &psi),(psi))

	interpolation (const GeometricField< Type, fvPatchField, volMesh > &psi)
	Construct from components. More...

virtual	~interpolation ()
	Destructor. More...

const GeometricField< Type, fvPatchField, volMesh > &	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 labelField &celli, const labelField &facei=NullObjectRef< labelField >()) 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 labelField &celli, const labelField &tetFacei, const labelField &tetPti, const labelField &facei=NullObjectRef< labelField >()) const =0
	As above, but for a field. More...

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

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

Protected Attributes
const GeometricField< Type, fvPatchField, volMesh > &	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 57 of file mappedPatchFieldBase.H.

Constructor & Destructor Documentation

◆ interpolation()

interpolation ( const GeometricField< Type, fvPatchField, volMesh > & psi )

Construct from components.

Definition at line 35 of file interpolation.C.

◆ ~interpolation()

virtual ~interpolation ( )

inlinevirtual

Destructor.

Definition at line 114 of file interpolation.H.

Member Function Documentation

◆ type()

virtual const word& type ( ) const

pure virtual

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		interpolation< Type >	,
		dictionary	,
		(const GeometricField< Type, fvPatchField, volMesh > &psi)	,
		(psi)
	)

◆ New() [1/2]

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

static

Return a reference to the specified interpolation scheme.

Definition at line 48 of file interpolation.C.

Referenced by interpolation< Foam::Vector >::interpolation(), interpolation< Foam::Vector >::New(), and streamlines::write().

Here is the caller graph for this function:

◆ New() [2/2]

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

static

Return a reference to the selected interpolation scheme.

Definition at line 72 of file interpolation.C.

◆ psi()

const GeometricField<Type, fvPatchField, volMesh>& psi ( ) const

inline

Return the field to be interpolated.

Definition at line 121 of file interpolation.H.

Referenced by ThermoParcel< ParcelType >::cellValueSourceCorrection(), cuttingPlane::interpolateField(), and distanceSurface::interpolateField().

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 interpolationCellPointFace< Type >, interpolationCellPoint< Type >, interpolationCellPoint< scalar >, interpolationCellPoint< Foam::Vector >, interpolationPointMVC< Type >, interpolationCellPatchConstrained< Type >, and interpolationCell< Type >.

Referenced by ThermoParcel< ParcelType >::calcHeatTransfer(), ParamagneticForce< CloudType >::calcNonCoupled(), ThermoParcel< ParcelType >::calcSurfaceValues(), plane::interpolateField(), isoSurface::interpolateField(), thresholdCellFaces::interpolateField(), patchInternalField::interpolateField(), patch::interpolateField(), triSurfaceMesh::interpolateField(), mappedPatchFieldBase< Type >::mappedField(), interpolation< Foam::Vector >::New(), interpolation< Foam::Vector >::psi(), sampledSets::sampleLocalType(), ThermoParcel< ParcelType >::setCellValues(), and MomentumParcel< ParcelType >::setCellValues().

Here is the caller graph for this function:

◆ interpolate() [2/4]

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

pure virtual

As above, but for a field.

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

◆ 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 85 of file interpolation.C.

◆ interpolate() [4/4]

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

pure virtual

As above, but for a field.

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

Member Data Documentation

◆ psi_

const GeometricField<Type, fvPatchField, volMesh>& psi_

protected

The vol field to interpolate.

Definition at line 61 of file interpolation.H.

Referenced by interpolation< Foam::Vector >::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/fields/fvPatchFields/derived/mappedField/mappedPatchFieldBase.H
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()

◆ ~interpolation()

Member Function Documentation

◆ type()

◆ declareRunTimeSelectionTable()

◆ New() [1/2]

◆ New() [2/2]

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