Harmonic-mean differencing scheme class. More...

Inheritance diagram for harmonic:
[legend]
Collaboration diagram for harmonic:
[legend]

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< surfaceScalarFieldweights (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...
 
- Public Member Functions inherited from surfaceInterpolationScheme< scalar >
 surfaceInterpolationScheme (const fvMesh &mesh)
 Construct from mesh. More...
 
 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))
 
virtual ~surfaceInterpolationScheme ()=default
 Destructor. More...
 
const fvMeshmesh () 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...
 
- Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Default construct, initializing count to 0. More...
 
int count () const noexcept
 Return the current reference count. More...
 
bool unique () const noexcept
 Return true if the reference count is zero. More...
 
void operator++ () noexcept
 Increment the reference count. More...
 
void operator++ (int) noexcept
 Increment the reference count. More...
 
void operator-- () noexcept
 Decrement the reference count. More...
 
void operator-- (int) noexcept
 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...
 

Detailed Description

Harmonic-mean differencing scheme class.

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

Source files

Definition at line 59 of file harmonic.H.

Constructor & Destructor Documentation

◆ harmonic() [1/3]

harmonic ( const fvMesh mesh)
inline

Construct from mesh.

Definition at line 78 of file harmonic.H.

◆ 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 87 of file harmonic.H.

◆ harmonic() [3/3]

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

Construct from faceFlux and Istream.

Definition at line 97 of file harmonic.H.

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 111 of file harmonic.H.

References NotImplemented.

◆ 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 123 of file harmonic.H.


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