Public Member Functions | Protected Types | List of all members
interpolationGradBase< Type > Class Template Referenceabstract
Inheritance diagram for interpolationGradBase< Type >:
Inheritance graph
[legend]
Collaboration diagram for interpolationGradBase< Type >:
Collaboration graph
[legend]

Public Member Functions

virtual const word & type () const =0
 Runtime type information. More...
 
virtual ~interpolationGradBase ()
 Destructor. More...
 
virtual interpolationGradType< Type > interpolateGrad (const vector &position, const label celli, const label facei=-1) const
 Interpolate the gradient to the given point in the given cell. More...
 
virtual tmp< Field< interpolationGradType< Type > > > interpolateGrad (const vectorField &position, const labelList &celli, const labelList &facei=NullObjectRef< labelList >()) const =0
 As above, but for a field. More...
 
virtual interpolationGradType< Type > interpolateGrad (const barycentric &coordinates, const tetIndices &tetIs, const label facei=-1) const
 Interpolate the gradient to the given coordinates in the. More...
 
virtual tmp< Field< interpolationGradType< Type > > > interpolateGrad (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...
 
- Public Member Functions inherited from interpolationBase< Type >
 interpolationBase (const VolField< Type > &psi)
 Construct from components. More...
 
 interpolationBase (const interpolationBase< Type > &i)
 Copy constructor. More...
 
virtual ~interpolationBase ()
 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 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 to the given coordinates in the. 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...
 

Protected Types

typedef outerProduct< Type, vector >::type GradType
 The type of the interpolated gradient. More...
 

Additional Inherited Members

- Protected Attributes inherited from interpolationBase< Type >
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::interpolationGradBase< Type >

Definition at line 140 of file interpolation.H.

Member Typedef Documentation

◆ GradType

typedef outerProduct<Type, vector>::type GradType
protected

The type of the interpolated gradient.

Definition at line 149 of file interpolation.H.

Constructor & Destructor Documentation

◆ ~interpolationGradBase()

~interpolationGradBase
virtual

Destructor.

Definition at line 94 of file interpolation.C.

Member Function Documentation

◆ type()

virtual const word& type ( ) const
pure virtual

Runtime type information.

◆ interpolateGrad() [1/4]

Foam::interpolationGradType< Type > interpolateGrad ( const vector &  position,
const label  celli,
const label  facei = -1 
) const
virtual

Interpolate the gradient to the given point in the given cell.

Fails with a "not supported" error unless overridden by derived interpolation types.

Definition at line 125 of file interpolation.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::type().

Here is the call graph for this function:

◆ interpolateGrad() [2/4]

virtual tmp<Field<interpolationGradType<Type> > > interpolateGrad ( const vectorField &  position,
const labelList &  celli,
const labelList &  facei = NullObjectRef< labelList >() 
) const
pure virtual

As above, but for a field.

◆ interpolateGrad() [3/4]

Foam::interpolationGradType< Type > interpolateGrad ( const barycentric &  coordinates,
const tetIndices &  tetIs,
const label  facei = -1 
) const
virtual

Interpolate the gradient to the given coordinates in the.

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

Definition at line 143 of file interpolation.C.

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

Here is the call graph for this function:

◆ interpolateGrad() [4/4]

virtual tmp<Field<interpolationGradType<Type> > > interpolateGrad ( 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.

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