FreeFOAM The Cross-Platform CFD Toolkit
upwind< Type > Class Template Reference

Upwind differencing scheme class. More...

#include <finiteVolume/upwind.H>


Detailed Description

template<class Type>
class Foam::upwind< Type >

Upwind differencing scheme class.

Source files

Definition at line 52 of file upwind.H.

+ Inheritance diagram for upwind< Type >:
+ Collaboration diagram for upwind< Type >:

List of all members.

Public Member Functions

 TypeName ("upwind")
 Runtime type information.
 upwind (const fvMesh &mesh, const surfaceScalarField &faceFlux)
 Construct from faceFlux.
 upwind (const fvMesh &mesh, Istream &is)
 Construct from Istream.
 upwind (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &)
 Construct from faceFlux and Istream.
virtual tmp< surfaceScalarFieldlimiter (const GeometricField< Type, fvPatchField, volMesh > &) const
 Return the interpolation limiter.
tmp< surfaceScalarFieldweights () const
 Return the interpolation weighting factors.
virtual tmp< surfaceScalarFieldweights (const GeometricField< Type, fvPatchField, volMesh > &) const
 Return the interpolation weighting factors.
- Public Member Functions inherited from limitedSurfaceInterpolationScheme< Type >
 TypeName ("limitedSurfaceInterpolationScheme")
 Runtime type information.
 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.
 limitedSurfaceInterpolationScheme (const fvMesh &mesh, Istream &is)
 Construct from mesh and Istream.
virtual ~limitedSurfaceInterpolationScheme ()
tmp< surfaceScalarFieldweights (const GeometricField< Type, fvPatchField, volMesh > &, const surfaceScalarField &CDweights, tmp< surfaceScalarField > tLimiter) const
 Return the interpolation weighting factors for the given field,.
virtual tmp< GeometricField
< Type, fvsPatchField,
surfaceMesh > > 
flux (const GeometricField< Type, fvPatchField, volMesh > &) const
 Return the interpolation weighting factors.
- 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 ()
const fvMeshmesh () const
 Return mesh reference.
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 > &) const
 Return the explicit correction to the face-interpolate.
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.
- Public Member Functions inherited from refCount
 refCount ()
 Construct null with zero count.
int count () const
 Return the reference count.
bool okToDelete () const
 Return true if the reference count is zero.
void resetRefCount ()
 Reset the reference count to zero.
void operator++ ()
 Increment the reference count.
void operator++ (int)
 Increment the reference count.
void operator-- ()
 Decrement the reference count.
void operator-- (int)
 Decrement the reference count.

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.
static tmp
< limitedSurfaceInterpolationScheme
< Type > > 
New (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &schemeData)
 Return new tmp interpolation scheme.
- Static Public Member Functions inherited from surfaceInterpolationScheme< Type >
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.
static tmp< GeometricField
< Type, fvsPatchField,
surfaceMesh > > 
interpolate (const GeometricField< Type, fvPatchField, volMesh > &, const tmp< surfaceScalarField > &)
 Return the face-interpolate of the given cell field.
- Protected Attributes inherited from limitedSurfaceInterpolationScheme< Type >
const surfaceScalarFieldfaceFlux_

Constructor & Destructor Documentation

upwind ( const fvMesh mesh,
const surfaceScalarField faceFlux 
)
inline

Construct from faceFlux.

Definition at line 72 of file upwind.H.

upwind ( 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 84 of file upwind.H.

upwind ( const fvMesh mesh,
const surfaceScalarField faceFlux,
Istream  
)
inline

Construct from faceFlux and Istream.

Definition at line 94 of file upwind.H.


Member Function Documentation

TypeName ( "upwind< Type >"  )

Runtime type information.

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

Return the interpolation limiter.

Implements limitedSurfaceInterpolationScheme< Type >.

Definition at line 108 of file upwind.H.

References Foam::dimless, surfaceInterpolationScheme< Type >::mesh(), and timeName.

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

Return the interpolation weighting factors.

Reimplemented from limitedSurfaceInterpolationScheme< Type >.

Definition at line 136 of file upwind.H.

References upwind< Type >::weights().


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