Abstract base class for volume field interpolation. More...

Inheritance diagram for interpolation< Type >:

[legend]

Collaboration diagram for interpolation< Type >:

[legend]

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 ()=default
	Destructor. More...

const GeometricField< Type, fvPatchField, volMesh > &	psi () const noexcept
	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 Type	interpolate (const barycentric &coordinates, const tetIndices &tetIs, const label facei=-1) const
	Interpolate field to the given coordinates in the tetrahedron defined by the given indices. 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_

const polyMesh &	pMesh_

const vectorField &	pMeshPoints_

const faceList &	pMeshFaces_

const vectorField &	pMeshFaceCentres_

const vectorField &	pMeshFaceAreas_

Detailed Description

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

Abstract base class for volume field interpolation.

Definition at line 92 of file mappedPatchFieldBase.H.

Constructor & Destructor Documentation

◆ interpolation()

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

explicit

Construct from components.

Definition at line 30 of file interpolation.C.

◆ ~interpolation()

virtual ~interpolation ( )

virtualdefault

Destructor.

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 29 of file interpolationNew.C.

◆ 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 52 of file interpolationNew.C.

◆ psi()

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

inlinenoexcept

Return the field to be interpolated.

Definition at line 133 of file interpolation.H.

Referenced by ThermoParcel< ParcelType >::cellValueSourceCorrection(), sampledPatch::sampleOnFaces(), sampledMeshedSurface::sampleOnFaces(), sampledPatchInternalField::sampleOnFaces(), sampledFaceZone::sampleOnFaces(), sampledCuttingPlane::sampleOnIsoSurfacePoints(), sampledDistanceSurface::sampleOnIsoSurfacePoints(), sampledIsoSurface::sampleOnIsoSurfacePoints(), and sampledMeshedSurface::sampleOnPoints().

Here is the caller graph for this function:

◆ interpolate() [1/2]

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

Referenced by ThermoParcel< ParcelType >::calcHeatTransfer(), InterfaceForce< CloudType >::calcNonCoupled(), ParamagneticForce< CloudType >::calcNonCoupled(), CoulombForce< CloudType >::calcNonCoupled(), ThermoParcel< ParcelType >::calcSurfaceValues(), interpolation< Foam::vector >::interpolate(), sampledSurface::sampleOnFaces(), sampledPatchInternalField::sampleOnPoints(), sampledSurface::sampleOnPoints(), sampledPatch::sampleOnPoints(), sampledMeshedSurface::sampleOnPoints(), sampledFaceZone::sampleOnPoints(), ReactingParcel< ParcelType >::setCellValues(), ThermoParcel< ParcelType >::setCellValues(), and KinematicParcel< ParcelType >::setCellValues().

Here is the caller graph for this function:

◆ interpolate() [2/2]

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

inlinevirtual

Interpolate field to the given coordinates in the tetrahedron defined by the given indices.

Calls interpolate function (vector, cell, face) except where overridden by derived interpolation types.

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

Definition at line 156 of file interpolation.H.

Member Data Documentation

◆ psi_

const GeometricField<Type, fvPatchField, volMesh>& psi_

protected

Definition at line 59 of file interpolation.H.

Referenced by interpolationCell< scalar >::interpolate(), and interpolation< Foam::vector >::psi().

◆ pMesh_

const polyMesh& pMesh_

protected

Definition at line 61 of file interpolation.H.

Referenced by interpolation< Foam::vector >::interpolate().

◆ pMeshPoints_

const vectorField& pMeshPoints_

protected

Definition at line 62 of file interpolation.H.

◆ pMeshFaces_

const faceList& pMeshFaces_

protected

Definition at line 63 of file interpolation.H.

◆ pMeshFaceCentres_

const vectorField& pMeshFaceCentres_

protected

Definition at line 64 of file interpolation.H.

◆ pMeshFaceAreas_

const vectorField& pMeshFaceAreas_

protected

Definition at line 65 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
src/finiteVolume/interpolation/interpolation/interpolation/interpolationNew.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/2]

◆ interpolate() [2/2]

Member Data Documentation

◆ psi_

◆ pMesh_

◆ pMeshPoints_

◆ pMeshFaces_

◆ pMeshFaceCentres_

◆ pMeshFaceAreas_

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