FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

LimitedScheme< Type, Limiter, LimitFunc > Class Template Reference

Class to create NVD/TVD limited weighting-factors. More...

#include <finiteVolume/LimitedScheme.H>


Detailed Description

template<class Type, class Limiter, template< class > class LimitFunc>
class Foam::LimitedScheme< Type, Limiter, LimitFunc >

Class to create NVD/TVD limited weighting-factors.

The particular differencing scheme class is supplied as a template argument, the weight function of which is called by the weight function of this class for the internal faces as well as faces of coupled patches (e.g. processor-processor patches). The weight function is supplied the central-differencing weighting factor, the face-flux, the cell and face gradients (from which the normalised variable distribution may be created) and the cell centre distance.

This code organisation is both neat and efficient, allowing for convenient implementation of new schemes to run on parallelised cases.

Source files

Definition at line 64 of file LimitedScheme.H.

Inheritance diagram for LimitedScheme< Type, Limiter, LimitFunc >:
Collaboration diagram for LimitedScheme< Type, Limiter, LimitFunc >:

List of all members.

Public Types

typedef Limiter  LimiterType

Public Member Functions

 TypeName ("LimitedScheme")
 Runtime type information.
 LimitedScheme (const fvMesh &mesh, const surfaceScalarField &faceFlux, const Limiter &weight)
 Construct from mesh and faceFlux and limiter scheme.
 LimitedScheme (const fvMesh &mesh, Istream &is)
 Construct from mesh and Istream.
 LimitedScheme (const fvMesh &mesh, const surfaceScalarField &faceFlux, Istream &is)
 Construct from mesh, faceFlux and Istream.
virtual tmp< surfaceScalarField >  limiter (const GeometricField< Type, fvPatchField, volMesh > &) const
 Return the interpolation weighting factors.

Member Typedef Documentation

typedef Limiter LimiterType

Definition at line 83 of file LimitedScheme.H.


Constructor & Destructor Documentation

LimitedScheme ( const fvMesh &   mesh,
const surfaceScalarField &   faceFlux,
const Limiter &   weight  
) [inline]

Construct from mesh and faceFlux and limiter scheme.

Definition at line 89 of file LimitedScheme.H.

LimitedScheme ( const fvMesh &   mesh,
Istream &   is  
) [inline]

Construct from mesh and Istream.

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

Definition at line 103 of file LimitedScheme.H.

LimitedScheme ( const fvMesh &   mesh,
const surfaceScalarField &   faceFlux,
Istream &   is  
) [inline]

Construct from mesh, faceFlux and Istream.

Definition at line 114 of file LimitedScheme.H.


Member Function Documentation

TypeName ( "LimitedScheme< Type, Limiter, LimitFunc >"    )

Runtime type information.


The documentation for this class was generated from the following files:
  • src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitedScheme.H
  • src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitedScheme.C