LocalMin-mean differencing scheme class. More...

Inheritance diagram for localMin< Type >:

Collaboration diagram for localMin< Type >:

Public Member Functions
	TypeName ("localMin")
	Runtime type information. More...

	localMin (const fvMesh &mesh)
	Construct from mesh. More...

	localMin (const fvMesh &mesh, Istream &is)
	Construct from Istream. More...

	localMin (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &is)
	Construct from faceFlux and Istream. More...

virtual tmp< surfaceScalarField >	weights (const GeometricField< Type, fvPatchField, volMesh > &) const
	Return the interpolation weighting factors. More...

virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &vf) const
	Return the face-interpolate of the given cell field. More...

Public Member Functions inherited from surfaceInterpolationScheme< Type >
	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...

virtual	~surfaceInterpolationScheme ()=default
	Destructor. More...

const fvMesh &	mesh () const
	Return mesh reference. More...

virtual bool	corrected () const
	Return true if this scheme uses an explicit correction. More...

virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	correction (const GeometricField< Type, fvPatchField, volMesh > &) const
	Return the explicit correction to the face-interpolate. More...

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

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

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const tmp< GeometricField< Type, fvPatchField, volMesh >> &) const
	Return the face-interpolate of the given tmp cell field. More...

Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0. More...

int	use_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< Type >
static tmp< surfaceInterpolationScheme< Type > >	New (const fvMesh &mesh, Istream &schemeData)
	Return new tmp interpolation scheme. More...

static tmp< surfaceInterpolationScheme< Type > >	New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
	Return new tmp interpolation scheme. More...

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

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

static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &)
	Return the face-interpolate of the given cell field. More...

Detailed Description

template<class Type>
class Foam::localMin< Type >

LocalMin-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 localMin.H.

Constructor & Destructor Documentation

◆ localMin() [1/3]

localMin ( const fvMesh & mesh )

inline

Construct from mesh.

Definition at line 80 of file localMin.H.

◆ localMin() [2/3]

localMin	(	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 92 of file localMin.H.

◆ localMin() [3/3]

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

inline

Construct from faceFlux and Istream.

Definition at line 104 of file localMin.H.

Member Function Documentation

◆ TypeName()

TypeName ( "localMin< Type >" )

Runtime type information.

◆ weights()

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

inlinevirtual

Return the interpolation weighting factors.

Implements surfaceInterpolationScheme< Type >.

Definition at line 120 of file localMin.H.

References NotImplemented.

◆ interpolate()

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

inlinevirtual

Return the face-interpolate of the given cell field.

Reimplemented from surfaceInterpolationScheme< Type >.

Definition at line 133 of file localMin.H.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), fvPatchFieldBase::coupled(), DimensionedField< Type, GeoMesh >::dimensions(), forAll, surfaceInterpolationScheme< Type >::mesh(), DimensionedField< Type, GeoMesh >::mesh(), Foam::min(), IOobject::name(), fvMesh::neighbour(), fvMesh::owner(), fvPatchField< Type >::patchInternalField(), fvPatchField< Type >::patchNeighbourField(), tmp< T >::ref(), fvMesh::time(), and Time::timeName().

Here is the call graph for this function:

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::localMin< Type >

Constructor & Destructor Documentation

◆ localMin() [1/3]

◆ localMin() [2/3]

◆ localMin() [3/3]

Member Function Documentation

◆ TypeName()

◆ weights()

◆ interpolate()

template<class Type>
class Foam::localMin< Type >