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

Inheritance diagram for UpwindFitData< Polynomial >:

Collaboration diagram for UpwindFitData< Polynomial >:

Public Member Functions
	TypeName ("UpwindFitData")

	UpwindFitData (const fvMesh &mesh, const extendedUpwindCellToFaceStencil &stencil, const bool linearCorrection, const scalar linearLimitFactor, const scalar centralWeight)
	Construct from components. More...

virtual	~UpwindFitData ()
	Destructor. More...

const List< scalarList > &	owncoeffs () const
	Return reference to owner fit coefficients. More...

const List< scalarList > &	neicoeffs () const
	Return reference to neighbour fit coefficients. More...

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

virtual	~FitData ()
	Destructor. More...

const extendedUpwindCellToFaceStencil &	stencil () const
	Return reference to the stencil. More...

scalar	linearLimitFactor () const
	Factor the fit is allowed to deviate from the base scheme. More...

scalar	centralWeight () const
	Return weight for central stencil. More...

label	dim () const
	Dimensionality of the geometry. More...

label	minSize () const
	Minimum stencil size. More...

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

bool	movePoints ()
	Recalculate weights (but not stencil) when the mesh moves. More...

Public Member Functions inherited from MeshObject< fvMesh, MoveableMeshObject, UpwindFitData< Polynomial > >
	MeshObject (const fvMesh &mesh)

virtual	~MeshObject ()

const fvMesh &	mesh () const

virtual bool	writeData (Foam::Ostream &) const

Public Member Functions inherited from MoveableMeshObject< fvMesh >
	MoveableMeshObject (const word &typeName, const objectRegistry &obr)

Public Member Functions inherited from GeometricMeshObject< fvMesh >
	GeometricMeshObject (const word &typeName, const objectRegistry &obr)

Public Member Functions inherited from TopologicalMeshObject< fvMesh >
	TopologicalMeshObject (const word &typeName, const objectRegistry &obr)

Public Member Functions inherited from meshObject
	ClassName ("meshObject")

	meshObject (const word &typeName, const objectRegistry &obr)

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Construct as copy. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Construct as copy, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Construct as copy with new name, transfering registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Construct as copy with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

virtual void	rename (const word &newName)
	Rename. More...

Istream &	readStream (const word &)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual bool	read ()
	Read object. More...

label	watchIndex () const
	Return file-monitoring handle. More...

label &	watchIndex ()
	Return file-monitoring handle. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
	Write using given format, version and compression. More...

virtual bool	write () const
	Write using setting from DB. More...

void	operator= (const IOobject &)

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

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

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

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const word &name)
	Construct as copy resetting name. More...

Foam::autoPtr< IOobject >	clone () const
	Clone. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () const
	Return the optional note. More...

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

fileName	path () const
	Return complete path. More...

fileName	path (const word &instance, const fileName &local="") const
	Return complete path with alternative instance and local. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read and check header info. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

Private Member Functions
void	calcFit ()
	Calculate the fit for the all the mesh faces. More...

Private Attributes
List< scalarList >	owncoeffs_
	For each face of the mesh store the coefficients to multiply the. More...

List< scalarList >	neicoeffs_
	For each face of the mesh store the coefficients to multiply the. More...

Additional Inherited Members
Public Types inherited from regIOobject
enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Types of communications. More...

Public Types inherited from IOobject
enum	objectState { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

Static Public Member Functions inherited from MeshObject< fvMesh, MoveableMeshObject, UpwindFitData< Polynomial > >
static const UpwindFitData< Polynomial > &	New (const fvMesh &mesh)

static const UpwindFitData< Polynomial > &	New (const fvMesh &mesh, const Data1 &d)

static const UpwindFitData< Polynomial > &	New (const fvMesh &mesh, const Data1 &, const Data2 &)

static const UpwindFitData< Polynomial > &	New (const fvMesh &mesh, const Data1 &, const Data2 &, const Data3 &)

static const UpwindFitData< Polynomial > &	New (const fvMesh &mesh, const Data1 &, const Data2 &, const Data3 &, const Data4 &)

static bool	Delete (const fvMesh &mesh)

Static Public Member Functions inherited from meshObject
template<class Mesh >
static void	movePoints (objectRegistry &)

template<class Mesh >
static void	updateMesh (objectRegistry &, const mapPolyMesh &)

template<class Mesh , template< class > class MeshObjectType>
static void	clear (objectRegistry &)

template<class Mesh , template< class > class FromType, template< class > class ToType>
static void	clearUpto (objectRegistry &)
	Clear all meshObject derived from FromType up to (but not including) More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

static void	replaceFileName (const word &from, const word &to)

Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static int	fileModificationSkew

static fileCheckTypes	fileModificationChecking

Protected Member Functions inherited from FitData< UpwindFitData< Polynomial >, extendedUpwindCellToFaceStencil, Polynomial >
void	findFaceDirs (vector &idir, vector &jdir, vector &kdir, const label faci)
	Find the normal direction (i) and j and k directions for face faci. More...

Protected Member Functions inherited from IOobject
Istream *	objectStream ()
	Construct and return an IFstream for the object. More...

Istream *	objectStream (const fileName &)
	Construct and return an IFstream for the object given the. More...

void	setBad (const string &)
	Set the object state to bad. More...

Protected Attributes inherited from MeshObject< fvMesh, MoveableMeshObject, UpwindFitData< Polynomial > >
const fvMesh &	mesh_

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

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 54 of file UpwindFitData.H.

Constructor & Destructor Documentation

◆ UpwindFitData()

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

Construct from components.

Definition at line 36 of file UpwindFitData.C.

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

Here is the call graph for this function:

◆ ~UpwindFitData()

virtual ~UpwindFitData ( )

inlinevirtual

Destructor.

Definition at line 100 of file UpwindFitData.H.

Member Function Documentation

◆ calcFit()

void calcFit

privatevirtual

Calculate the fit for the all the mesh faces.

and set the coefficients

Implements FitData< UpwindFitData< Polynomial >, extendedUpwindCellToFaceStencil, Polynomial >.

Definition at line 75 of file UpwindFitData.C.

References fvsPatchField::coupled(), forAll, mesh, fvsPatchField::patch(), patchi, fvPatch::start(), and w().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "UpwindFitData< Polynomial >" )

◆ owncoeffs()

const List<scalarList>& owncoeffs ( ) const

inline

Return reference to owner fit coefficients.

Definition at line 107 of file UpwindFitData.H.

References UpwindFitData< Polynomial >::owncoeffs_.

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

Here is the caller graph for this function:

◆ neicoeffs()

const List<scalarList>& neicoeffs ( ) const

inline

Return reference to neighbour fit coefficients.

Definition at line 113 of file UpwindFitData.H.

References UpwindFitData< Polynomial >::neicoeffs_.

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

Here is the caller graph for this function:

Field Documentation

◆ owncoeffs_

List<scalarList> owncoeffs_

private

For each face of the mesh store the coefficients to multiply the.

stencil cell values by if the flow is from the owner

Definition at line 67 of file UpwindFitData.H.

Referenced by UpwindFitData< Polynomial >::owncoeffs().

◆ neicoeffs_

List<scalarList> neicoeffs_

private

For each face of the mesh store the coefficients to multiply the.

stencil cell values by if the flow is from the neighbour

Definition at line 71 of file UpwindFitData.H.

Referenced by UpwindFitData< Polynomial >::neicoeffs().

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

src/finiteVolume/interpolation/surfaceInterpolation/schemes/UpwindFitScheme/UpwindFitData.H
src/finiteVolume/interpolation/surfaceInterpolation/schemes/UpwindFitScheme/UpwindFitData.C

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members