Data for the upwinded and centred polynomial fit interpolation schemes. The linearCorrection_ determines whether the fit is for a corrected linear scheme (first two coefficients are corrections for owner and neighbour) or a pure upwind scheme (first coefficient is correction for owner; weight on face taken as 1). More...

Inheritance diagram for FitData< FitDataType, ExtendedStencil, Polynomial >:

[legend]

Collaboration diagram for FitData< FitDataType, ExtendedStencil, Polynomial >:

[legend]

Public Member Functions
	FitData (const fvMesh &mesh, const ExtendedStencil &stencil, const bool linearCorrection, const scalar linearLimitFactor, const scalar centralWeight)
	Construct from components. More...

virtual	~FitData ()
	Destructor. More...

const ExtendedStencil &	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...

virtual void	calcFit ()=0
	Calculate the fit for all the faces. More...

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

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

	MeshObject (const fvMesh &mesh, const IOobject &io)

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)

	MoveableMeshObject (const word &typeName, const IOobject &io)

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

	GeometricMeshObject (const word &typeName, const IOobject &io)

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

	TopologicalMeshObject (const word &typeName, const IOobject &io)

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

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

	meshObject (const word &typeName, const IOobject &io)

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 &)
	Copy constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

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

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

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) 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...

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

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

Istream &	readStream (const word &, const bool read=true)
	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...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. 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	global () const
	Is object same for all processors. More...

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

virtual bool	write (const bool write=true) 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 objectRegistry &registry)
	Construct from copy resetting registry. More...

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

	IOobject (const IOobject &io)=default
	Copy constructor. More...

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

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. 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...

word &	headerClassName ()
	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...

word	modelName (const char *name) const
	Return the name of the object within this model. 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	localPath () const
	Return the path relative to the case. More...

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

fileName	localObjectPath () const
	Return complete localPath + object name. More...

fileName	localFilePath (const word &typeName) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName) const
	Helper for filePath that searches up if in parallel. More...

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

template<class Type >
bool	typeHeaderOk (const bool checkType=true)
	Read header (uses typeFilePath to find file) and check header. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. 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)

template<class Name >
Foam::word	modelName (Name name, const word &model)

Protected Member Functions
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 regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &)
	Set the object state to bad. More...

Additional Inherited Members
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...

enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

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

static const FitDataType &	New (const fvMesh &mesh)

static FitDataType &	New (fvMesh &mesh, const Args &... args)

static const FitDataType &	New (const fvMesh &mesh, const Args &... args)

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 >
static void	addPatch (objectRegistry &, const label patchi)

template<class Mesh >
static void	reorderPatches (objectRegistry &, const labelUList &newToOld, const bool validBoundary)

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)

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

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

template<class Name >
static word	modelName (Name name, const word &model)
	Return the name of the object within the given model. More...

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 Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

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

Detailed Description

template<class FitDataType, class ExtendedStencil, class Polynomial>
class Foam::FitData< FitDataType, ExtendedStencil, Polynomial >

Data for the upwinded and centred polynomial fit interpolation schemes. The linearCorrection_ determines whether the fit is for a corrected linear scheme (first two coefficients are corrections for owner and neighbour) or a pure upwind scheme (first coefficient is correction for owner; weight on face taken as 1).

Source files

Definition at line 54 of file FitData.H.

Constructor & Destructor Documentation

◆ FitData()

FitData	(	const fvMesh &	mesh,
		const ExtendedStencil &	stencil,
		const bool	linearCorrection,
		const scalar	linearLimitFactor,
		const scalar	centralWeight
	)

Construct from components.

Definition at line 35 of file FitData.C.

◆ ~FitData()

virtual ~FitData ( )

inlinevirtual

Destructor.

Definition at line 109 of file FitData.H.

Member Function Documentation

◆ findFaceDirs()

void findFaceDirs	(	vector &	idir,
		vector &	jdir,
		vector &	kdir,
		const label	faci
	)

protected

Find the normal direction (i) and j and k directions for face faci.

Definition at line 70 of file FitData.C.

Referenced by FitData< CentredFitSnGradData< Polynomial >, extendedCentredCellToFaceStencil, Polynomial >::FitData().

Here is the caller graph for this function:

◆ stencil()

const ExtendedStencil& stencil ( ) const

inline

Return reference to the stencil.

Definition at line 116 of file FitData.H.

◆ linearLimitFactor()

scalar linearLimitFactor ( ) const

inline

Factor the fit is allowed to deviate from the base scheme.

Definition at line 122 of file FitData.H.

◆ centralWeight()

scalar centralWeight ( ) const

inline

Return weight for central stencil.

Definition at line 128 of file FitData.H.

◆ dim()

label dim ( ) const

inline

Dimensionality of the geometry.

Definition at line 134 of file FitData.H.

◆ minSize()

label minSize ( ) const

inline

Minimum stencil size.

Definition at line 140 of file FitData.H.

◆ linearCorrection()

bool linearCorrection ( ) const

inline

Definition at line 145 of file FitData.H.

◆ calcFit() [1/2]

void calcFit	(	scalarList &	coeffsi,
		const List< point > &	C,
		const scalar	wLin,
		const label	faci
	)

Calculate the fit for the specified face and set the coefficients.

Definition at line 132 of file FitData.C.

◆ calcFit() [2/2]

virtual void calcFit ( )

pure virtual

Calculate the fit for all the faces.

Implemented in CentredFitSnGradData< Polynomial >.

Referenced by FitData< CentredFitSnGradData< Polynomial >, extendedCentredCellToFaceStencil, Polynomial >::findFaceDirs(), and FitData< CentredFitSnGradData< Polynomial >, extendedCentredCellToFaceStencil, Polynomial >::linearCorrection().

Here is the caller graph for this function:

◆ movePoints()

bool movePoints ( )

virtual

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

Implements MoveableMeshObject< fvMesh >.

Definition at line 316 of file FitData.C.

Referenced by FitData< CentredFitSnGradData< Polynomial >, extendedCentredCellToFaceStencil, Polynomial >::linearCorrection().

Here is the caller graph for this function:

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

src/finiteVolume/interpolation/surfaceInterpolation/schemes/FitData/FitData.H
src/finiteVolume/interpolation/surfaceInterpolation/schemes/FitData/FitData.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<class FitDataType, class ExtendedStencil, class Polynomial> class Foam::FitData< FitDataType, ExtendedStencil, Polynomial >

Constructor & Destructor Documentation

◆ FitData()

◆ ~FitData()

Member Function Documentation

◆ findFaceDirs()

◆ stencil()

◆ linearLimitFactor()

◆ centralWeight()

◆ dim()

◆ minSize()

◆ linearCorrection()

◆ calcFit() [1/2]

◆ calcFit() [2/2]

◆ movePoints()

template<class FitDataType, class ExtendedStencil, class Polynomial>
class Foam::FitData< FitDataType, ExtendedStencil, Polynomial >