Loading...
Searching...
No Matches

Harmonic-mean differencing scheme class. More...

#include <harmonic.H>

Inheritance diagram for harmonic:
Collaboration diagram for harmonic:

Public Member Functions

 TypeName ("harmonic")
 Runtime type information.
 harmonic (const fvMesh &mesh)
 Construct from mesh.
 harmonic (const fvMesh &mesh, Istream &is)
 Construct from Istream.
 harmonic (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &is)
 Construct from faceFlux and Istream.
virtual tmp< surfaceScalarFieldweights (const GeometricField< scalar, fvPatchField, volMesh > &) const
 Return the interpolation weighting factors.
virtual tmp< GeometricField< scalar, fvsPatchField, surfaceMesh > > interpolate (const GeometricField< scalar, fvPatchField, volMesh > &vf) const
 Return the face-interpolate of the given cell field.
Public Member Functions inherited from surfaceInterpolationScheme< scalar >
Foam::tmp< Foam::GeometricField< typename Foam::innerProduct< typename SFType::value_type, scalar >::type, Foam::fvsPatchField, Foam::surfaceMesh > > dotInterpolate (const SFType &Sf, const GeometricField< scalar, fvPatchField, volMesh > &vf, const tmp< surfaceScalarField > &tlambdas)
tmp< GeometricField< typename innerProduct< vector, scalar >::type, fvsPatchField, surfaceMesh > > dotInterpolate (const surfaceVectorField &Sf, const GeometricField< scalar, fvPatchField, volMesh > &) const
Foam::tmp< Foam::GeometricField< typename Foam::innerProduct< Foam::vector, Foam::scalar >::type, Foam::fvsPatchField, Foam::surfaceMesh > > dotInterpolate (const surfaceVectorField &Sf, const GeometricField< scalar, fvPatchField, volMesh > &) const
 TypeName ("surfaceInterpolationScheme")
 Runtime type information.
 declareRunTimeSelectionTable (tmp, surfaceInterpolationScheme, Mesh,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))
virtual ~surfaceInterpolationScheme ()=default
 Destructor.
const fvMeshmesh () const
 Return mesh reference.
virtual bool corrected () const
 Return true if this scheme uses an explicit correction.
virtual tmp< GeometricField< scalar, fvsPatchField, surfaceMesh > > correction (const GeometricField< scalar, fvPatchField, volMesh > &) const
 Return the explicit correction to the face-interpolate.
Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Default construct, initializing count to 0.
int use_count () const noexcept
 Return the current reference count.
bool unique () const noexcept
 Return true if the reference count is zero.
void operator++ () noexcept
 Increment the reference count.
void operator++ (int) noexcept
 Increment the reference count.
void operator-- () noexcept
 Decrement the reference count.
void operator-- (int) noexcept
 Decrement the reference count.

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.
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.

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

Constructor & Destructor Documentation

◆ harmonic() [1/3]

harmonic ( const fvMesh & mesh)
inline

Construct from mesh.

Definition at line 80 of file harmonic.H.

References surfaceInterpolationScheme< scalar >::mesh().

Here is the call 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 91 of file harmonic.H.

References surfaceInterpolationScheme< scalar >::mesh().

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

References surfaceInterpolationScheme< scalar >::mesh().

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 119 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.

Definition at line 132 of file harmonic.H.

References surfaceInterpolationScheme< Type >::interpolate(), and DimensionedField< Type, GeoMesh >::mesh().

Here is the call graph for this function:

The documentation for this class was generated from the following file:
  • src/finiteVolume/interpolation/surfaceInterpolation/schemes/harmonic/harmonic.H