harmonic Class Reference

Harmonic-mean interpolation scheme class. More...

Inheritance diagram for harmonic:

Collaboration diagram for harmonic:

Public Member Functions
	TypeName ("harmonic")
	Runtime type information. More...
	harmonic (const fvMesh &mesh)
	Construct from mesh. More...
	harmonic (const fvMesh &mesh, Istream &is)
	Construct from Istream. More...
	harmonic (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &is)
	Construct from faceFlux and Istream. More...
virtual tmp< surfaceScalarField >	weights (const GeometricField< scalar, fvPatchField, volMesh > &) const
	Return the interpolation weighting factors. More...
virtual tmp< GeometricField< scalar, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< scalar, fvPatchField, volMesh > &vf) const
	Return the face-interpolate of the given cell field. More...
void	operator= (const harmonic &)=delete
	Disallow default bitwise assignment. More...
Public Member Functions inherited from surfaceInterpolationScheme< scalar >
	TypeName ("surfaceInterpolationScheme")
	Runtime type information. More...
	declareRunTimeSelectionTable (tmp, surfaceInterpolationScheme, Mesh,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
	declareRunTimeSelectionTable (tmp, surfaceInterpolationScheme, MeshFlux,(const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData),(mesh, faceFlux, schemeData))
	surfaceInterpolationScheme (const fvMesh &mesh)
	Construct from mesh. More...
	surfaceInterpolationScheme (const surfaceInterpolationScheme &)
	Disallow default bitwise copy construction. More...
virtual	~surfaceInterpolationScheme ()
	Destructor. More...
const fvMesh &	mesh () const
	Return mesh reference. More...
tmp< GeometricField< scalar, fvsPatchField, surfaceMesh > >	interpolate (const tmp< GeometricField< scalar, fvPatchField, volMesh >> &) const
	Return the face-interpolate of the given tmp cell field. More...
virtual tmp< GeometricField< typename innerProduct< vector, scalar >::type, fvsPatchField, surfaceMesh > >	dotInterpolate (const surfaceVectorField &Sf, const GeometricField< scalar, fvPatchField, volMesh > &vf) const
	Return the face-interpolate of the given cell field. More...
tmp< GeometricField< typename innerProduct< vector, scalar >::type, fvsPatchField, surfaceMesh > >	dotInterpolate (const surfaceVectorField &Sf, const tmp< GeometricField< scalar, fvPatchField, volMesh >> &) const
	Return the face-interpolate of the given tmp cell field. More...
virtual bool	corrected () const
	Return true if this scheme uses an explicit correction. More...
virtual tmp< GeometricField< scalar, fvsPatchField, surfaceMesh > >	correction (const GeometricField< scalar, fvPatchField, volMesh > &) const
	Return the explicit correction to the face-interpolate. More...
void	operator= (const surfaceInterpolationScheme &)=delete
	Disallow default bitwise assignment. More...
Public Member Functions inherited from refCount
int	count () const
	Return the current reference count. More...
bool	unique () const
	Return true if the reference count is zero. More...
void	operator++ ()
	Increment the reference count. More...
void	operator++ (int)
	Increment the reference count. More...
void	operator-- ()
	Decrement the reference count. More...
void	operator-- (int)
	Decrement the reference count. More...

Additional Inherited Members
Static Public Member Functions inherited from surfaceInterpolationScheme< scalar >
static tmp< surfaceInterpolationScheme< scalar > >	New (const fvMesh &mesh, Istream &schemeData)
	Return new tmp interpolation scheme. More...
static tmp< surfaceInterpolationScheme< scalar > >	New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
	Return new tmp interpolation scheme. More...
static tmp< GeometricField< scalar, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< scalar, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &, const tmp< surfaceScalarField > &)
	Return the face-interpolate of the given cell field. More...
static tmp< GeometricField< scalar, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< scalar, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &)
	Return the face-interpolate of the given cell field. More...
static tmp< GeometricField< typename innerProduct< typename SFType::value_type, scalar >::type, fvsPatchField, surfaceMesh > >	dotInterpolate (const SFType &Sf, const GeometricField< scalar, fvPatchField, volMesh > &vf, const tmp< surfaceScalarField > &tlambdas)
	Return the face-interpolate of the given cell field. More...
Protected Member Functions inherited from refCount
	refCount ()
	Construct null initialising count to 0. More...

Detailed Description

Harmonic-mean interpolation scheme class.

This scheme interpolates 1/field using a scheme specified at run-time and return the reciprocal of the interpolate.

Source files

• harmonic.H
• harmonic.C

Definition at line 54 of file harmonic.H.

Constructor & Destructor Documentation

harmonic() [1/3]

harmonic ( const fvMesh &  mesh )

inline

Construct from mesh.

Definition at line 68 of file harmonic.H.

Referenced by harmonic::harmonic().

Here is the caller graph for this function:

harmonic() [2/3]

harmonic ( const fvMesh &  mesh, Istream &  is  )

inline

Construct from Istream.

The name of the flux field is read from the Istream and looked-up from the mesh objectRegistry

Definition at line 77 of file harmonic.H.

References harmonic::harmonic().

Here is the call graph for this function:

harmonic() [3/3]

harmonic ( const fvMesh &  mesh, const surfaceScalarField &  faceFlux, Istream &  is  )

inline

Construct from faceFlux and Istream.

Definition at line 87 of file harmonic.H.

References harmonic::weights().

Here is the call graph for this function:

Member Function Documentation

TypeName()

TypeName

(

"harmonic"

)

Runtime type information.

weights()

virtual tmp<surfaceScalarField> weights ( const GeometricField< scalar, fvPatchField, volMesh > &  ) const

inlinevirtual

Return the interpolation weighting factors.

Implements surfaceInterpolationScheme< scalar >.

Definition at line 101 of file harmonic.H.

References harmonic::interpolate(), and NotImplemented.

Referenced by harmonic::harmonic().

Here is the call graph for this function:

Here is the caller graph for this function:

interpolate()

virtual tmp<GeometricField<scalar, fvsPatchField, surfaceMesh> > interpolate ( const GeometricField< scalar, fvPatchField, volMesh > &  vf ) const

inlinevirtual

Return the face-interpolate of the given cell field.

Reimplemented from surfaceInterpolationScheme< scalar >.

Definition at line 113 of file harmonic.H.

References DimensionedField< Type, GeoMesh >::mesh(), and harmonic::operator=().

Referenced by harmonic::weights().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

void operator= ( const harmonic &  )

delete

Disallow default bitwise assignment.

Referenced by harmonic::interpolate().

Here is the caller graph for this function:

---

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

• src/finiteVolume/interpolation/surfaceInterpolation/schemes/harmonic/harmonic.H