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

#include <interpolation.H>

Inheritance diagram for interpolation< Type >:

[legend]

Collaboration diagram for interpolation< Type >:

[legend]

Public Member Functions
virtual const word &	type () const =0
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, interpolation, dictionary,(const GeometricField< Type, fvPatchField, volMesh > &psi),(psi))
	interpolation (const GeometricField< Type, fvPatchField, volMesh > &psi)
	Construct from components.
virtual	~interpolation ()=default
	Destructor.
const GeometricField< Type, fvPatchField, volMesh > &	psi () const noexcept
	Return the field to be interpolated.
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.
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.

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.
static autoPtr< interpolation< Type > >	New (const dictionary &interpolationSchemes, const GeometricField< Type, fvPatchField, volMesh > &psi)
	Return a reference to the selected interpolation scheme.

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 53 of file interpolation.H.

Constructor & Destructor Documentation

◆ interpolation()

template<class Type>

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

explicit

Construct from components.

Definition at line 29 of file interpolation.C.

References mesh, pMesh_, pMeshFaceAreas_, pMeshFaceCentres_, pMeshFaces_, pMeshPoints_, points, psi(), and psi_.

Referenced by declareRunTimeSelectionTable(), interpolationCell< Type >::interpolationCell(), interpolationCellPatchConstrained< Type >::interpolationCellPatchConstrained(), interpolationCellPoint< Type >::interpolationCellPoint(), interpolationCellPointFace< Type >::interpolationCellPointFace(), interpolationPointMVC< Type >::interpolationPointMVC(), and interpolationPointMVC< Type >::TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~interpolation()

template<class Type>

virtual ~interpolation ( )

virtualdefault

Destructor.

Member Function Documentation

◆ type()

template<class Type>

virtual const word & type ( ) const

pure virtual

Runtime type information.

◆ declareRunTimeSelectionTable()

template<class Type>

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

References interpolation(), and psi().

Here is the call graph for this function:

◆ New() [1/2]

template<class Type>

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

References Foam::exit(), Foam::FatalError, FatalErrorInLookup, and psi().

Referenced by CoulombForce< CloudType >::cacheFields(), InterfaceForce< CloudType >::cacheFields(), LiftForce< CloudType >::cacheFields(), ParamagneticForce< CloudType >::cacheFields(), PressureGradientForce< CloudType >::cacheFields(), streamLineBase::initInterpolations(), propellerInfo::interpolate(), interpolationCellPoint< Type >::interpolationCellPoint(), interpolationCellPointFace< Type >::interpolationCellPointFace(), interpolationPointMVC< Type >::interpolationPointMVC(), mappedPatchFieldBase< Type >::mappedField(), New(), Sample< Type >::value(), and Sampled< Type >::value().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New() [2/2]

template<class Type>

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

References dictionary::lookup(), New(), and psi().

Here is the call graph for this function:

◆ psi()

template<class Type>

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

inlinenoexcept

Return the field to be interpolated.

Definition at line 133 of file interpolation.H.

References Foam::noexcept, and psi_.

Referenced by declareRunTimeSelectionTable(), interpolation(), interpolationCell< Type >::interpolationCell(), interpolationCellPatchConstrained< Type >::interpolationCellPatchConstrained(), interpolationCellPoint< Type >::interpolationCellPoint(), interpolationCellPointFace< Type >::interpolationCellPointFace(), interpolationCellPointWallModified< Type >::interpolationCellPointWallModified(), interpolationPointMVC< Type >::interpolationPointMVC(), New(), New(), sampledFaceZone::sampleOnFaces(), sampledMeshedSurface::sampleOnFaces(), sampledPatch::sampleOnFaces(), sampledPatchInternalField::sampleOnFaces(), sampledCuttingPlane::sampleOnIsoSurfacePoints(), sampledDistanceSurface::sampleOnIsoSurfacePoints(), sampledIsoSurface::sampleOnIsoSurfacePoints(), sampledMeshedSurface::sampleOnPoints(), interpolationCell< Type >::TypeName(), interpolationCellPatchConstrained< Type >::TypeName(), interpolationCellPoint< Type >::TypeName(), interpolationCellPointFace< Type >::TypeName(), interpolationCellPointWallModified< Type >::TypeName(), and interpolationPointMVC< Type >::TypeName().

Here is the caller graph for this function:

◆ interpolate() [1/2]

template<class Type>

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

Referenced by CoulombForce< CloudType >::calcNonCoupled(), InterfaceForce< CloudType >::calcNonCoupled(), ParamagneticForce< CloudType >::calcNonCoupled(), interpolate(), sampledSurface::sampleOnFaces(), sampledFaceZone::sampleOnPoints(), sampledMeshedSurface::sampleOnPoints(), sampledPatch::sampleOnPoints(), sampledPatchInternalField::sampleOnPoints(), and sampledSurface::sampleOnPoints().

Here is the caller graph for this function:

◆ interpolate() [2/2]

template<class Type>

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 interpolationCell< Type >, interpolationCellPatchConstrained< Type >, interpolationCellPoint< Type >, and interpolationCellPointWallModified< Type >.

Definition at line 155 of file interpolation.H.

References tetrahedron< Point, PointRef >::barycentricToPoint(), tetIndices::cell(), coordinates(), interpolate(), pMesh_, and tetIndices::tet().

Here is the call graph for this function:

Member Data Documentation

◆ psi_

template<class Type>

const GeometricField<Type, fvPatchField, volMesh>& psi_

protected

Definition at line 59 of file interpolation.H.

Referenced by interpolationCell< Type >::interpolate(), interpolationCell< Type >::interpolate(), interpolationCellPatchConstrained< Type >::interpolate(), interpolationCellPoint< Type >::interpolate(), interpolationCellPoint< Type >::interpolate(), interpolationCellPointFace< Type >::interpolate(), interpolationCellPointWallModified< Type >::interpolate(), interpolation(), and psi().

◆ pMesh_

template<class Type>

const polyMesh& pMesh_

protected

Definition at line 61 of file interpolation.H.

Referenced by interpolate(), interpolationCellPoint< Type >::interpolate(), interpolationCellPointFace< Type >::interpolate(), interpolationCellPointWallModified< Type >::interpolate(), interpolationCellPointWallModified< Type >::interpolate(), interpolationPointMVC< Type >::interpolate(), and interpolation().

◆ pMeshPoints_

template<class Type>

const vectorField& pMeshPoints_

protected

Definition at line 62 of file interpolation.H.

Referenced by interpolation().

◆ pMeshFaces_

template<class Type>

const faceList& pMeshFaces_

protected

Definition at line 63 of file interpolation.H.

Referenced by interpolation().

◆ pMeshFaceCentres_

template<class Type>

const vectorField& pMeshFaceCentres_

protected

Definition at line 64 of file interpolation.H.

Referenced by interpolationCellPointFace< Type >::interpolate(), and interpolation().

◆ pMeshFaceAreas_

template<class Type>

const vectorField& pMeshFaceAreas_

protected

Definition at line 65 of file interpolation.H.

Referenced by interpolationCellPointFace< Type >::interpolate(), and interpolation().

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

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_