linearUpwind interpolation scheme class derived from upwind and returns upwind weighting factors and also applies a gradient-based explicit correction. More...

Inheritance diagram for linearUpwind< Type >:

[legend]

Collaboration diagram for linearUpwind< Type >:

[legend]

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

	linearUpwind (const fvMesh &mesh, const surfaceScalarField &faceFlux)
	Construct from faceFlux. More...

	linearUpwind (const fvMesh &mesh, Istream &schemeData)
	Construct from Istream. More...

	linearUpwind (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
	Construct from faceFlux and Istream. More...

	linearUpwind (const linearUpwind &)=delete
	Disallow default bitwise copy construction. 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...

void	operator= (const linearUpwind &)=delete
	Disallow default bitwise assignment. More...

template<>
Foam::tmp< Foam::surfaceVectorField >	correction (const volVectorField &vf) const

template<>
tmp< surfaceVectorField >	correction (const volVectorField &vf) const

Public Member Functions inherited from upwind< Type >
	TypeName ("upwind")
	Runtime type information. More...

	upwind (const fvMesh &mesh, const surfaceScalarField &faceFlux)
	Construct from faceFlux. More...

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

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

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

tmp< surfaceScalarField >	weights () const
	Return the interpolation weighting factors. More...

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

void	operator= (const upwind &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from limitedSurfaceInterpolationScheme< Type >
	TypeName ("limitedSurfaceInterpolationScheme")
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, limitedSurfaceInterpolationScheme, Mesh,(const fvMesh &mesh, Istream &schemeData),(mesh, schemeData))

	declareRunTimeSelectionTable (tmp, limitedSurfaceInterpolationScheme, MeshFlux,(const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData),(mesh, faceFlux, schemeData))

	limitedSurfaceInterpolationScheme (const fvMesh &mesh, const surfaceScalarField &faceFlux)
	Construct from mesh and faceFlux. More...

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

	limitedSurfaceInterpolationScheme (const limitedSurfaceInterpolationScheme &)
	Disallow default bitwise copy construction. More...

virtual	~limitedSurfaceInterpolationScheme ()
	Destructor. More...

tmp< surfaceScalarField >	weights (const GeometricField< Type, fvPatchField, volMesh > &, const surfaceScalarField &CDweights, tmp< surfaceScalarField > tLimiter) const
	Return the interpolation weighting factors for the given field,. More...

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

void	operator= (const limitedSurfaceInterpolationScheme &)=delete
	Disallow default bitwise assignment. 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...

	surfaceInterpolationScheme (const surfaceInterpolationScheme &)
	Disallow default bitwise copy construction. More...

virtual	~surfaceInterpolationScheme ()
	Destructor. More...

const fvMesh &	mesh () const
	Return mesh reference. 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...

virtual tmp< GeometricField< Type, fvsPatchField, surfaceMesh > >	interpolate (const GeometricField< Type, fvPatchField, volMesh > &) const
	Return the face-interpolate of the given 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...

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

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

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

Protected Member Functions inherited from refCount
	refCount ()
	Construct null initialising count to 0. More...

Protected Attributes inherited from limitedSurfaceInterpolationScheme< Type >
const surfaceScalarField &	faceFlux_

Detailed Description

template<class Type>
class Foam::linearUpwind< Type >

linearUpwind interpolation scheme class derived from upwind and returns upwind weighting factors and also applies a gradient-based explicit correction.

Source files

Definition at line 52 of file linearUpwind.H.

Constructor & Destructor Documentation

◆ linearUpwind() [1/4]

linearUpwind	(	const fvMesh &	mesh,
		const surfaceScalarField &	faceFlux
	)

Construct from faceFlux.

Definition at line 32 of file linearUpwindTemplates.C.

Referenced by linearUpwind< Type >::linearUpwind().

Here is the caller graph for this function:

◆ linearUpwind() [2/4]

linearUpwind	(	const fvMesh &	mesh,
		Istream &	schemeData
	)

Construct from Istream.

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

Definition at line 44 of file linearUpwindTemplates.C.

References linearUpwind< Type >::linearUpwind().

Here is the call graph for this function:

◆ linearUpwind() [3/4]

linearUpwind	(	const fvMesh &	mesh,
		const surfaceScalarField &	faceFlux,
		Istream &	schemeData
	)

Construct from faceFlux and Istream.

Definition at line 56 of file linearUpwindTemplates.C.

References linearUpwind< Type >::correction().

Here is the call graph for this function:

◆ linearUpwind() [4/4]

linearUpwind ( const linearUpwind< Type > & )

delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "linearUpwind< Type >" )

Runtime type information.

◆ corrected()

virtual bool corrected ( ) const

inlinevirtual

Return true if this scheme uses an explicit correction.

Reimplemented from surfaceInterpolationScheme< Type >.

Reimplemented in LUST< Type >.

Definition at line 100 of file linearUpwind.H.

References linearUpwind< Type >::correction(), and linearUpwind< Type >::operator=().

Here is the call graph for this function:

◆ correction() [1/3]

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

virtual

Return the explicit correction to the face-interpolate.

Reimplemented from surfaceInterpolationScheme< Type >.

Reimplemented in LUST< Type >.

Definition at line 72 of file linearUpwindTemplates.C.

References fvMesh::boundary(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), fvMesh::C(), fvMesh::Cf(), GeometricField< Type, PatchField, GeoMesh >::component(), fvsPatchField< Type >::coupled(), DimensionedField< Type, GeoMesh >::dimensions(), forAll, fvSchemes::grad(), mesh, IOobject::name(), fvMesh::neighbour(), fvMesh::owner(), patchi, GeometricField< Type, PatchField, GeoMesh >::ref(), fvMesh::schemes(), Foam::setComponent(), and Foam::Zero.

Referenced by linearUpwind< Type >::corrected(), LUST< Type >::correction(), and linearUpwind< Type >::linearUpwind().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const linearUpwind< Type > & )

delete

Disallow default bitwise assignment.

Referenced by linearUpwind< Type >::corrected().

Here is the caller graph for this function:

◆ correction() [2/3]

Foam::tmp< Foam::surfaceVectorField > correction ( const volVectorField & vf ) const

Definition at line 33 of file linearUpwind.C.

References fvMesh::boundary(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), fvMesh::C(), fvMesh::Cf(), fvsPatchField< Type >::coupled(), DimensionedField< Type, GeoMesh >::dimensions(), forAll, fvSchemes::grad(), makelimitedSurfaceInterpolationScheme, mesh, IOobject::name(), fvMesh::neighbour(), Foam::compressible::New(), fvMesh::owner(), patchi, GeometricField< Type, PatchField, GeoMesh >::ref(), fvMesh::schemes(), and Foam::Zero.

Here is the call graph for this function:

◆ correction() [3/3]

tmp< surfaceVectorField > correction ( const volVectorField & vf ) const

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

src/finiteVolume/interpolation/surfaceInterpolation/schemes/linearUpwind/linearUpwind.H
src/finiteVolume/interpolation/surfaceInterpolation/schemes/linearUpwind/linearUpwindTemplates.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::linearUpwind< Type >

Constructor & Destructor Documentation

◆ linearUpwind() [1/4]

◆ linearUpwind() [2/4]

◆ linearUpwind() [3/4]

◆ linearUpwind() [4/4]

Member Function Documentation

◆ TypeName()

◆ corrected()

◆ correction() [1/3]

◆ operator=()

◆ correction() [2/3]

◆ correction() [3/3]

template<class Type>
class Foam::linearUpwind< Type >