FreeFOAM The Cross-Platform CFD Toolkit
UpwindFitData< Polynomial > Class Template Reference

Data for the quadratic fit correction interpolation scheme to be used with upwind biased stencil. More...

#include <finiteVolume/UpwindFitData.H>


Detailed Description

template<class Polynomial>
class Foam::UpwindFitData< Polynomial >

Data for the quadratic fit correction interpolation scheme to be used with upwind biased stencil.

- linearCorrection = true : fit calculated for corrected linear scheme

  • linearCorrection = false : fit calculated for corrected upwind scheme
Source files

Definition at line 55 of file UpwindFitData.H.

+ Inheritance diagram for UpwindFitData< Polynomial >:
+ Collaboration diagram for UpwindFitData< Polynomial >:

List of all members.

Public Member Functions

 TypeName ("UpwindFitData")
 UpwindFitData (const fvMesh &mesh, const extendedUpwindCellToFaceStencil &stencil, const bool linearCorrection, const scalar linearLimitFactor, const scalar centralWeight)
 Construct from components.
virtual ~UpwindFitData ()
 Destructor.
const List< scalarList > & owncoeffs () const
 Return reference to owner fit coefficients.
const List< scalarList > & neicoeffs () const
 Return reference to neighbour fit coefficients.
- Public Member Functions inherited from FitData< UpwindFitData< Polynomial >, extendedUpwindCellToFaceStencil, Polynomial >
 FitData (const fvMesh &mesh, const extendedUpwindCellToFaceStencil &stencil, const bool linearCorrection, const scalar linearLimitFactor, const scalar centralWeight)
 Construct from components.
virtual ~FitData ()
 Destructor.
const
extendedUpwindCellToFaceStencil
stencil () const
 Return reference to the stencil.
bool linearCorrection () const
void calcFit (scalarList &coeffsi, const List< point > &, const scalar wLin, const label faci)
 Calculate the fit for the specified face and set the coefficients.
bool movePoints ()
 Recalculate weights (but not stencil) when the mesh moves.
- Public Member Functions inherited from MeshObject< fvMesh, UpwindFitData< Polynomial > >
 MeshObject (const fvMesh &mesh)
virtual ~MeshObject ()
const fvMeshmesh () const
virtual bool writeData (Foam::Ostream &) const
 Pure virtual writaData function.
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information.
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the.
 regIOobject (const regIOobject &)
 Construct as copy.
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, and transferring registry registration to copy.
virtual ~regIOobject ()
bool checkIn ()
 Add object to registry.
bool checkOut ()
 Remove object from registry.
bool ownedByRegistry () const
 Is this object owned by the registry?
void store ()
 Transfer ownership of this object to its registry.
void release ()
 Release ownership of this object from its registry.
label eventNo () const
 Event number at last update.
label & eventNo ()
 Event number at last update.
bool upToDate (const word &) const
 Am I uptodate with respect to other regIOobjects.
bool upToDate (const word &, const word &) const
bool upToDate (const word &, const word &, const word &) const
bool upToDate (const word &, const word &, const word &, const word &) const
void setUpToDate ()
 Flag me as up to date.
virtual void rename (const word &newName)
 Rename.
IstreamreadStream (const word &)
 Return Istream and check object type against that given.
void close ()
 Close Istream.
virtual bool readData (Istream &)
 Virtual readData function.
virtual bool read ()
 Read object.
virtual bool modified () const
 Return true if the object's file has been modified.
virtual bool readIfModified ()
 Read object if modified.
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression.
virtual bool write () const
 Write using setting from DB.
void operator= (const IOobject &)
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information.
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options.
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options.
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options.
Foam::autoPtr< IOobjectclone () const
 Clone.
virtual ~IOobject ()
const Timetime () const
 Return time.
const objectRegistrydb () const
 Return the local objectRegistry.
const wordname () const
 Return name.
const wordheaderClassName () const
 Return name of the class name read from header.
stringnote ()
 Return non-constant access to the optional note.
const stringnote () const
 Return the optional note.
bool registerObject () const
 Register object created from this IOobject with registry if true.
readOption readOpt () const
readOptionreadOpt ()
writeOption writeOpt () const
writeOptionwriteOpt ()
const fileNamerootPath () const
const fileNamecaseName () const
const fileNameinstance () const
fileNameinstance ()
const fileNamelocal () const
fileName path () const
 Return complete path.
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local.
fileName objectPath () const
 Return complete path + object name.
fileName filePath () const
 Return complete path + object name if the file exists.
bool readHeader (Istream &)
 Read header.
bool headerOk ()
 Read and check header info.
bool writeHeader (Ostream &) const
 Write header.
bool good () const
bool bad () const
InfoProxy< IOobjectinfo () const
 Return info proxy.

Constructor & Destructor Documentation

UpwindFitData ( const fvMesh mesh,
const extendedUpwindCellToFaceStencil stencil,
const bool  linearCorrection,
const scalar  linearLimitFactor,
const scalar  centralWeight 
)

Construct from components.

Definition at line 37 of file UpwindFitData.C.

References Foam::endl(), and Foam::Info.

virtual ~UpwindFitData ( )
inlinevirtual

Destructor.

Definition at line 101 of file UpwindFitData.H.


Member Function Documentation

TypeName ( "UpwindFitData< Polynomial >"  )
const List<scalarList>& owncoeffs ( ) const
inline

Return reference to owner fit coefficients.

Definition at line 108 of file UpwindFitData.H.

Referenced by PureUpwindFitScheme< Type, Polynomial, Stencil >::correction(), and UpwindFitScheme< Type, Polynomial, Stencil >::correction().

const List<scalarList>& neicoeffs ( ) const
inline

Return reference to neighbour fit coefficients.

Definition at line 114 of file UpwindFitData.H.

Referenced by PureUpwindFitScheme< Type, Polynomial, Stencil >::correction(), and UpwindFitScheme< Type, Polynomial, Stencil >::correction().


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