Cubic interpolation scheme class derived from linear and returns linear weighting factors but also applies an explicit correction. More...

#include <cubic.H>

Inheritance diagram for cubic< Type >:

[legend]

Collaboration diagram for cubic< Type >:

[legend]

Public Member Functions
	TypeName ("cubic")
	Runtime type information.
	cubic (const fvMesh &mesh)
	Construct from mesh.
	cubic (const fvMesh &mesh, Istream &)
	Construct from mesh and Istream.
	cubic (const fvMesh &mesh, const surfaceScalarField &, Istream &)
	Construct from mesh, faceFlux and Istream.
virtual bool	corrected () const
	Return true if this scheme uses an explicit correction.
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	correction (const GeometricField< Type, fvPatchField, volMesh > &vf) const
	Return the explicit correction to the face-interpolate.
Public Member Functions inherited from linear< Type >
	TypeName ("linear")
	Runtime type information.
	linear (const fvMesh &mesh)
	Construct from mesh.
	linear (const fvMesh &mesh, Istream &)
	Construct from Istream.
	linear (const fvMesh &mesh, const surfaceScalarField &, Istream &)
	Construct from faceFlux and Istream.
tmp< surfaceScalarField >	weights (const GeometricField< Type, fvPatchField, volMesh > &) const
	Return the interpolation weighting factors.
	linear (const Specie &sp, const scalar psi, const scalar rho0)
	Construct from components.
	linear (const dictionary &dict)
	Construct from dictionary.
	linear (const word &name, const linear &)
	Construct as named copy.
autoPtr< linear >	clone () const
	Construct and return a clone.
scalar	rho (scalar p, scalar T) const
	Return density [kg/m^3].
scalar	H (const scalar p, const scalar T) const
	Return enthalpy departure [J/kg].
scalar	Cp (scalar p, scalar T) const
	Return Cp departure [J/(kg K].
scalar	E (const scalar p, const scalar T) const
	Return internal energy departure [J/kg].
scalar	Cv (scalar p, scalar T) const
	Return Cv departure [J/(kg K].
scalar	S (const scalar p, const scalar T) const
	Return entropy [J/(kg K)].
scalar	psi (scalar p, scalar T) const
	Return compressibility rho/p [s^2/m^2].
scalar	Z (scalar p, scalar T) const
	Return compression factor [].
scalar	CpMCv (scalar p, scalar T) const
	Return (Cp - Cv) [J/(kg K].
void	write (Ostream &os) const
	Write to Ostream.
void	operator+= (const linear &)
void	operator*= (const scalar)
Public Member Functions inherited from surfaceInterpolationScheme< Type >
	TypeName ("surfaceInterpolationScheme")
	Runtime type information.
	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.
virtual	~surfaceInterpolationScheme ()=default
	Destructor.
const fvMesh &	mesh () const
	Return mesh reference.
virtual tmp< GeometricField< typename innerProduct< vector, Type >::type, fvsPatchField, surfaceMesh > >	dotInterpolate (const surfaceVectorField &Sf, const GeometricField< Type, fvPatchField, volMesh > &vf) const
	Return the face-interpolate of the given cell field.
tmp< GeometricField< typename innerProduct< vector, Type >::type, fvsPatchField, surfaceMesh > >	dotInterpolate (const surfaceVectorField &Sf, const tmp< GeometricField< Type, fvPatchField, volMesh > > &) const
	Return the face-interpolate of the given tmp cell field.
virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &) const
	Return the face-interpolate of the given cell field.
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const tmp< GeometricField< Type, fvPatchField, volMesh > > &) const
	Return the face-interpolate of the given tmp cell field.
template<class SFType>
Foam::tmp< Foam::GeometricField< typename Foam::innerProduct< typename SFType::value_type, Type >::type, Foam::fvsPatchField, Foam::surfaceMesh > >	dotInterpolate (const SFType &Sf, const GeometricField< Type, 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
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 linear< Type >
static autoPtr< linear >	New (const dictionary &dict)
static word	typeName ()
	Return the instantiated type name.
Static Public Member Functions inherited from surfaceInterpolationScheme< Type >
static tmp< surfaceInterpolationScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
	Return new tmp interpolation scheme.
static tmp< surfaceInterpolationScheme< Type > >	New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
	Return new tmp interpolation scheme.
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &, const tmp< surfaceScalarField > &)
	Return the face-interpolate of the given cell field.
template<class SFType>
static tmp< GeometricField< typename innerProduct< typename SFType::value_type, Type >::type, fvsPatchField, surfaceMesh > >	dotInterpolate (const SFType &Sf, const GeometricField< Type, fvPatchField, volMesh > &vf, const tmp< surfaceScalarField > &tlambdas)
	Return the face-interpolate of the given cell field.
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &)
	Return the face-interpolate of the given cell field.
Static Public Attributes inherited from linear< Type >
static const bool	incompressible = false
	Is the equation of state is incompressible i.e. rho != f(p).
static const bool	isochoric = false
	Is the equation of state is isochoric i.e. rho = const.

Detailed Description

template<class Type>
class Foam::cubic< Type >

Cubic interpolation scheme class derived from linear and returns linear weighting factors but also applies an explicit correction.

Source files

Definition at line 52 of file cubic.H.

Constructor & Destructor Documentation

◆ cubic() [1/3]

template<class Type>

cubic ( const fvMesh & mesh )

inline

Construct from mesh.

Definition at line 82 of file cubic.H.

References linear< Type >::linear(), and surfaceInterpolationScheme< Type >::mesh().

Here is the call graph for this function:

◆ cubic() [2/3]

template<class Type>

cubic	(	const fvMesh &	mesh,
		Istream &	)

inline

Construct from mesh and Istream.

Definition at line 90 of file cubic.H.

References linear< Type >::linear(), and surfaceInterpolationScheme< Type >::mesh().

Here is the call graph for this function:

◆ cubic() [3/3]

template<class Type>

cubic	(	const fvMesh &	mesh,
		const surfaceScalarField &	,
		Istream &	)

inline

Construct from mesh, faceFlux and Istream.

Definition at line 102 of file cubic.H.

References linear< Type >::linear(), and surfaceInterpolationScheme< Type >::mesh().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

template<class Type>

TypeName ( "cubic< Type >" )

Runtime type information.

◆ corrected()

template<class Type>

virtual bool corrected ( ) const

inlinevirtual

Return true if this scheme uses an explicit correction.

Reimplemented from surfaceInterpolationScheme< Type >.

Definition at line 118 of file cubic.H.

◆ correction()

template<class Type>

virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > correction ( const GeometricField< Type, fvPatchField, volMesh > & vf ) const

inlinevirtual

Return the explicit correction to the face-interpolate.

Reimplemented from surfaceInterpolationScheme< Type >.

Definition at line 127 of file cubic.H.

References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), GeometricField< Type, PatchField, GeoMesh >::component(), coupled, forAll, surfaceInterpolationScheme< Type >::interpolate(), lambda(), surfaceInterpolationScheme< Type >::mesh(), IOobject::name(), IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, pi(), tmp< T >::ref(), GeometricField< Type, PatchField, GeoMesh >::replace(), Foam::sqr(), and Foam::Zero.

Here is the call graph for this function:

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

src/finiteVolume/interpolation/surfaceInterpolation/schemes/cubic/cubic.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cubic() [1/3]

◆ cubic() [2/3]

◆ cubic() [3/3]

Member Function Documentation

◆ TypeName()

◆ corrected()

◆ correction()