Finite area mesh. Used for 2-D non-Euclidian finite area method. More...

Inheritance diagram for faMesh:

Collaboration diagram for faMesh:

Public Types
typedef faMesh	Mesh

typedef faBoundaryMesh	BoundaryMesh

Public Types inherited from GeoMesh< polyMesh >
typedef polyMesh	Mesh

typedef polyMesh ::BoundaryMesh	BoundaryMesh

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

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

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

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

Public Types inherited from dictionary
typedef Searcher< true >	const_searcher
	Searcher with const access. More...

typedef Searcher< false >	searcher
	Searcher with non-const access. More...

Public Member Functions
	TypeName ("faMesh")
	Runtime type information. More...

	faMesh (const polyMesh &m)
	Construct from polyMesh. More...

	faMesh (const polyMesh &m, const labelList &faceLabels)
	Construct from components without boundary. More...

	faMesh (const polyMesh &m, const fileName &defFile)
	Construct from finite area mesh definition file. More...

	faMesh (const polyMesh &m, const label polyPatchID)
	Construct from polyPatch. More...

virtual	~faMesh ()
	Destructor. More...

void	addFaPatches (const List< faPatch * > &)
	Add boundary patches. Constructor helper. More...

const polyMesh &	mesh () const
	Return access to polyMesh. More...

fileName	meshDir () const
	Return the local mesh directory (dbDir()/meshSubDir) More...

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

const fileName &	pointsInstance () const
	Return the current instance directory for points. More...

const fileName &	facesInstance () const
	Return the current instance directory for faces. More...

label	nPoints () const

label	nEdges () const

label	nInternalEdges () const

label	nFaces () const

const pointField &	points () const
	Return mesh points. More...

const edgeList &	edges () const
	Return edges. More...

const faceList &	faces () const
	Return faces. More...

const labelList &	edgeOwner () const
	Edge owner addressing. More...

const labelList &	edgeNeighbour () const
	Edge neighbour addressing. More...

label	comm () const
	Return communicator used for parallel communication. More...

label &	comm ()
	Return communicator used for parallel communication. More...

virtual bool	hasDb () const
	Return true if thisDb() is a valid DB. More...

virtual const objectRegistry &	thisDb () const
	Return reference to the mesh database. More...

const word &	name () const
	Name function is needed to disambiguate those inherited. More...

const faBoundaryMesh &	boundary () const
	Return constant reference to boundary mesh. More...

const labelList &	faceLabels () const
	Return faMesh face labels. More...

const faGlobalMeshData &	globalData () const
	Return parallel info. More...

virtual const lduAddressing &	lduAddr () const
	Return ldu addressing. More...

virtual lduInterfacePtrsList	interfaces () const
	Return a list of pointers for each patch. More...

const labelUList &	owner () const
	Internal face owner. More...

const labelUList &	neighbour () const
	Internal face neighbour. More...

bool	isInternalEdge (const label edgeIndex) const
	Return true if given edge label is internal to the mesh. More...

bool	moving () const
	Is mesh moving. More...

virtual bool	movePoints ()
	Update after mesh motion. More...

virtual void	updateMesh (const mapPolyMesh &)
	Update after topo change. More...

virtual void	mapFields (const faMeshMapper &mapper) const
	Map all fields in time using given map. More...

virtual void	mapOldAreas (const faMeshMapper &mapper) const
	Map face areas in time using given map. More...

const indirectPrimitivePatch &	patch () const
	Return constant reference to primitive patch. More...

indirectPrimitivePatch &	patch ()
	Return reference to primitive patch. More...

const labelList &	patchStarts () const
	Return patch starts. More...

const edgeVectorField &	Le () const
	Return edge length vectors. More...

const edgeScalarField &	magLe () const
	Return edge length magnitudes. More...

const areaVectorField &	areaCentres () const
	Return face centres as areaVectorField. More...

const edgeVectorField &	edgeCentres () const
	Return edge centres as edgeVectorField. More...

const DimensionedField< scalar, areaMesh > &	S () const
	Return face areas. More...

const DimensionedField< scalar, areaMesh > &	S0 () const
	Return old-time face areas. More...

const DimensionedField< scalar, areaMesh > &	S00 () const
	Return old-old-time face areas. More...

const areaVectorField &	faceAreaNormals () const
	Return face area normals. More...

const edgeVectorField &	edgeAreaNormals () const
	Return edge area normals. More...

const vectorField &	pointAreaNormals () const
	Return point area normals. More...

const areaScalarField &	faceCurvatures () const
	Return face curvatures. More...

const FieldField< Field, tensor > &	edgeTransformTensors () const
	Return edge transformation tensors. More...

labelList	internalPoints () const
	Return internal point labels. More...

labelList	boundaryPoints () const
	Return boundary point labels. More...

tmp< edgeScalarField >	edgeLengthCorrection () const
	Return edge length correction. More...

bool	correctPatchPointNormals (const label patchID) const
	Whether point normals should be corrected for a patch. More...

boolList &	correctPatchPointNormals () const
	Set whether point normals should be corrected for a patch. More...

virtual bool	write (const bool valid=true) const
	Write mesh. More...

bool	operator!= (const faMesh &m) const

bool	operator== (const faMesh &m) const

Public Member Functions inherited from GeoMesh< polyMesh >
	GeoMesh (const polyMesh &mesh)
	Construct from MESH. More...

bool	hasDb () const
	Return true if thisDb() is a valid DB - here = false. More...

const objectRegistry &	thisDb () const
	Return the object registry. More...

const polyMesh &	operator() () const
	Return reference to polyMesh. More...

Public Member Functions inherited from MeshObject< polyMesh, Foam::UpdateableMeshObject, faMesh >
	MeshObject (const polyMesh &mesh)
	Construct on Mesh type. More...

virtual	~MeshObject ()=default
	Destructor. More...

const polyMesh &	mesh () const

virtual bool	writeData (Ostream &os) const

Public Member Functions inherited from UpdateableMeshObject< polyMesh >
	UpdateableMeshObject (const word &typeName, const objectRegistry &obr)
	Construct from name and instance on registry. More...

Public Member Functions inherited from MoveableMeshObject< polyMesh >
	MoveableMeshObject (const word &typeName, const objectRegistry &obr)
	Construct from name and instance on registry. More...

Public Member Functions inherited from GeometricMeshObject< polyMesh >
	GeometricMeshObject (const word &typeName, const objectRegistry &obr)
	Construct from name and instance on registry. More...

Public Member Functions inherited from TopologicalMeshObject< polyMesh >
	TopologicalMeshObject (const word &typeName, const objectRegistry &obr)
	Construct from name and instance on registry. More...

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

	meshObject (const word &typeName, const objectRegistry &obr)
	Construct from name and instance on registry. More...

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

	regIOobject (const IOobject &io, const bool isTime=false)

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and remove object from registry. More...

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

bool	store ()

void	release (const bool unregister=false)
	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 as up-to-date. More...

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

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

Istream &	readStream (const word &, const bool valid=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. More...

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

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

virtual bool	modified () const

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

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. More...

void	operator= (const IOobject &io)
	Copy assignment. More...

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

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch) More...

	IOobject (const IOobject &)=default
	Copy construct. More...

virtual	~IOobject ()=default
	Destructor. 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, bool globalObject=false)
	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, bool globalObject=false)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

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

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

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

const Time &	time () const
	Return time. 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 non-constant access to the class name read from header. More...

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

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

bool	registerObject () const
	Should object created with this IOobject be registered? More...

bool &	registerObject ()
	Should object created with this IOobject be registered? More...

bool	globalObject () const
	Is object same for all processors? More...

bool &	globalObject ()
	Is object same for all processors? More...

unsigned	labelByteSize () const
	The label byte-size, possibly read from the header. More...

unsigned	scalarByteSize () const
	The scalar byte-size, possibly read from the header. More...

bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...

template<class Type >
bool	isHeaderClassName () const
	Test if headerClassName() equals Type::typeName. More...

readOption	readOpt () const
	The read option. More...

readOption &	readOpt ()
	Non-constant access to the read option. More...

writeOption	writeOpt () const
	The write option. More...

writeOption &	writeOpt ()
	Non-constant access to the write option. More...

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
	The complete path. More...

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

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

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

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

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

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

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

bool	writeHeader (Ostream &os, 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 &io)

template<>
bool	isHeaderClassName () const
	Specialization for `void` always returns true (no headerClassName check). More...

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

template<class StringType >
Foam::word	scopedName (StringType scope, const word &name)

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

virtual	~lduMesh ()=default
	Destructor. More...

template<class T , class BinaryOp >
void	reduce (T &Value, const BinaryOp &bop) const
	Helper: reduce with current communicator. More...

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

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

	edgeInterpolation (const faMesh &)
	Construct given an faMesh. More...

	~edgeInterpolation ()
	Destructor. More...

const faMesh &	mesh () const
	Return mesh reference. More...

const edgeScalarField &	lPN () const
	Return reference to PN geodesic distance. More...

const edgeScalarField &	weights () const
	Return reference to weighting factors array. More...

const edgeScalarField &	deltaCoeffs () const
	Return reference to difference factors array. More...

bool	orthogonal () const
	Return whether mesh is orthogonal or not. More...

const edgeVectorField &	correctionVectors () const
	Return reference to non-orthogonality correction vectors array. More...

bool	skew () const
	Return whether mesh is skew or not. More...

const edgeVectorField &	skewCorrectionVectors () const
	Return reference to skew vectors array. More...

bool	movePoints () const
	Do what is necessary if the mesh has moved. More...

Public Member Functions inherited from faSchemes
	faSchemes (const objectRegistry &obr)
	Construct from objectRegistry. More...

const dictionary &	schemesDict () const

ITstream &	ddtScheme (const word &name) const

ITstream &	d2dt2Scheme (const word &name) const

ITstream &	interpolationScheme (const word &name) const

ITstream &	divScheme (const word &name) const

ITstream &	gradScheme (const word &name) const

ITstream &	lnGradScheme (const word &name) const

ITstream &	laplacianScheme (const word &name) const

void	setFluxRequired (const word &name) const

bool	fluxRequired (const word &name) const

dictionary &	ddtSchemes ()
	Return access to ddt schemes. More...

dictionary &	d2dt2Schemes ()
	Return access to d2dt2 schemes. More...

dictionary &	interpolationSchemes ()
	Return access to interpolation schemes. More...

dictionary &	divSchemes ()
	Return access to div schemes. More...

dictionary &	gradSchemes ()
	Return access to grad schemes. More...

dictionary &	lnGradSchemes ()
	Return access to lnGrad schemes. More...

dictionary &	laplacianSchemes ()
	Return access to laplacian schemes. More...

dictionary &	fluxRequired ()
	Return access to flux required. More...

bool	read ()
	Read the faSchemes. More...

virtual bool	writeData (Ostream &) const
	WriteData function required for regIOobject write operation. More...

Public Member Functions inherited from IOdictionary
	IOdictionary (const IOobject &)
	Construct given an IOobject. More...

	IOdictionary (const IOobject &, const dictionary &)
	Construct given an IOobject and dictionary. More...

	IOdictionary (const IOobject &, Istream &)
	Construct given an IOobject and Istream. More...

virtual	~IOdictionary ()
	Destructor. More...

virtual bool	global () const
	Is object global. More...

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

Public Member Functions inherited from baseIOdictionary
	TypeName ("dictionary")
	Declare type-name, virtual type (with debug switch) More...

	baseIOdictionary (const baseIOdictionary &)=default
	Copy construct. More...

	baseIOdictionary (baseIOdictionary &&)=default
	Move construct. More...

virtual	~baseIOdictionary ()=default
	Destructor. More...

	baseIOdictionary (const IOobject &)
	Construct given an IOobject. More...

	baseIOdictionary (const IOobject &, const dictionary &)
	Construct given an IOobject and dictionary. More...

	baseIOdictionary (const IOobject &, Istream &)
	Construct given an IOobject and Istream. More...

const word &	name () const

virtual bool	readData (Istream &)
	The readData function required by regIOobject read operation. More...

void	operator= (const baseIOdictionary &)
	Copy assignment of dictionary entries (leave regIOobject untouched) More...

void	operator= (const dictionary &rhs)
	Copy assignment of dictionary entries. More...

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

	dictionary ()
	Construct top-level dictionary null. More...

	dictionary (const fileName &name)
	Construct top-level empty dictionary with given name. More...

	dictionary (const fileName &name, const dictionary &parentDict, Istream &is, bool keepHeader=false)

	dictionary (Istream &is)

	dictionary (Istream &is, bool keepHeader)

	dictionary (const dictionary &parentDict, const dictionary &dict)
	Copy construct given the parent dictionary. More...

	dictionary (const dictionary &dict)
	Copy construct top-level dictionary. More...

	dictionary (const dictionary *dict)
	Construct top-level dictionary as copy from pointer to dictionary. More...

	dictionary (const dictionary &parentDict, dictionary &&dict)
	Move construct for given parent dictionary. More...

	dictionary (dictionary &&dict)
	Move construct top-level dictionary. More...

autoPtr< dictionary >	clone () const
	Construct and return clone. More...

virtual	~dictionary ()
	Destructor. More...

const fileName &	name () const
	The dictionary name. More...

fileName &	name ()
	The dictionary name for modification (use with caution). More...

word	dictName () const
	The local dictionary name (final part of scoped name) More...

const dictionary &	parent () const
	Return the parent dictionary. More...

const dictionary &	topDict () const
	Return the top of the tree. More...

label	startLineNumber () const
	Return line number of first token in dictionary. More...

label	endLineNumber () const
	Return line number of last token in dictionary. More...

SHA1Digest	digest () const
	Return the SHA1 digest of the dictionary contents. More...

tokenList	tokens () const
	Return the dictionary as a list of tokens. More...

bool	found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for an entry (const access) with the given keyword. More...

entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find for an entry (non-const access) with the given keyword. More...

const entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find an entry (const access) with the given keyword. More...

const entry *	findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for a scoped entry (const access) with the given keyword. More...

dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary pointer if present. More...

const dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary pointer if present. More...

const entry &	lookupEntry (const word &keyword, enum keyType::option matchOpt) const
	Search for an entry (const access) with the given keyword. More...

ITstream &	lookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)

template<class T >
bool	readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const

template<class T >
bool	readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

template<class T , class Predicate >
T	getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)

template<class T , class Predicate >
bool	readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const

template<class T , class Predicate >
bool	readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const

bool	isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Check if entry is found and is a sub-dictionary. More...

const dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary. More...

dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation. More...

dictionary &	subDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation. More...

dictionary	subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const

const dictionary &	optionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary, otherwise return this dictionary. More...

wordList	toc () const
	Return the table of contents. More...

wordList	sortedToc () const
	Return the sorted table of contents. More...

template<class Compare >
wordList	sortedToc (const Compare &comp) const
	Return table of contents sorted using the specified comparator. More...

List< keyType >	keys (bool patterns=false) const
	Return the list of available keys or patterns. More...

bool	substituteKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given keyword (which is prefixed by '$') More...

bool	substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
	Substitute the given scoped keyword (which is prefixed by '$') More...

entry *	add (entry *entryPtr, bool mergeEntry=false)
	Add a new entry. More...

entry *	add (const entry &e, bool mergeEntry=false)
	Add an entry. More...

entry *	add (const keyType &k, const word &v, bool overwrite=false)
	Add a word entry. More...

entry *	add (const keyType &k, const string &v, bool overwrite=false)
	Add a string entry. More...

entry *	add (const keyType &k, const label v, bool overwrite=false)
	Add a label entry. More...

entry *	add (const keyType &k, const scalar v, bool overwrite=false)
	Add a scalar entry. More...

entry *	add (const keyType &k, const dictionary &d, bool mergeEntry=false)
	Add a dictionary entry. More...

template<class T >
entry *	add (const keyType &k, const T &v, bool overwrite=false)
	Add a T entry. More...

entry *	set (entry *entryPtr)
	Assign a new entry, overwriting any existing entry. More...

entry *	set (const entry &e)
	Assign a new entry, overwriting any existing entry. More...

entry *	set (const keyType &k, const dictionary &v)
	Assign a dictionary entry, overwriting any existing entry. More...

template<class T >
entry *	set (const keyType &k, const T &v)
	Assign a T entry, overwriting any existing entry. More...

bool	remove (const word &keyword)
	Remove an entry specified by keyword. More...

bool	changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
	Change the keyword for an entry,. More...

bool	merge (const dictionary &dict)
	Merge entries from the given dictionary. More...

void	clear ()
	Clear the dictionary. More...

void	transfer (dictionary &dict)
	Transfer the contents of the argument and annul the argument. More...

void	checkITstream (const ITstream &is, const word &keyword) const

bool	read (Istream &is)
	Read dictionary from Istream. More...

bool	read (Istream &is, bool keepHeader)
	Read dictionary from Istream, optionally keeping the header. More...

void	writeEntry (Ostream &os) const
	Write sub-dictionary with its dictName as its header. More...

void	writeEntry (const keyType &keyword, Ostream &os) const
	Write sub-dictionary with the keyword as its header. More...

void	writeEntries (Ostream &os, const bool extraNewLine=false) const
	Write dictionary entries. More...

void	write (Ostream &os, const bool subDict=true) const
	Write dictionary, normally with sub-dictionary formatting. More...

const_searcher	csearch (const word &keyword, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword. More...

const_searcher	search (const word &keyword, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword. More...

searcher	search (const word &keyword, enum keyType::option=keyType::REGEX)
	Search dictionary for given keyword. More...

const_searcher	csearchScoped (const word &keyword, enum keyType::option) const
	Search using scoping. More...

const_searcher	searchScoped (const word &keyword, enum keyType::option) const
	Search using dot or slash scoping. More...

searcher	searchScoped (const word &keyword, enum keyType::option)
	Search using dot or slash scoping. More...

const dictionary *	cfindScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...

const dictionary *	findScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...

dictionary *	findScopedDict (const fileName &dictPath)
	Locate a sub-dictionary using slash-scoping. More...

dictionary *	makeScopedDict (const fileName &dictPath)
	Locate existing or create sub-dictionary using slash-scoping. More...

const_searcher	csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword and any compatibility names. More...

bool	foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
	Search dictionary for given keyword and any compatibility names. More...

const entry *	findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

const entry &	lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

ITstream &	lookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

template<class T >
T	getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const

template<class T >
T	getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const

template<class T >
bool	readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const

template<class T >
bool	readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const

void	operator= (const dictionary &rhs)
	Copy assignment. More...

void	operator+= (const dictionary &rhs)
	Include entries from the given dictionary. More...

void	operator\|= (const dictionary &rhs)
	Conditionally include entries from the given dictionary. More...

void	operator<<= (const dictionary &rhs)
	Unconditionally include entries from the given dictionary. More...

template<class T >
T	lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

template<class T >
T	lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)

template<class T >
T	lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const

ITstream &	operator[] (const word &keyword) const
	Deprecated(2018-07) find and return an entry data stream. More...

template<class T >
T	lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
	Deprecated(2018-10) find and return a T. More...

bool	found (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
	Deprecated(2018-10) More...

const entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

const entry *	lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

const dictionary *	subDictPtr (const word &keyword) const
	Deprecated(2018-10) More...

dictionary *	subDictPtr (const word &keyword)

const entry &	lookupEntry (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

ITstream &	lookup (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

template<class T >
T	lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
	Deprecated(2018-10) More...

template<class T >
bool	readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

bool	getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< bool >(const word&, keyType::option) More...

label	getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< label >(const word&, keyType::option) More...

scalar	getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< scalar >(const word&, keyType::option) More...

string	getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< string >(const word&, keyType::option) More...

word	getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< word >(const word&, keyType::option) More...

fileName	getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Same as get< fileName >(const word&, keyType::option) More...

template<class Compare >
Foam::wordList	sortedToc (const Compare &comp) const

template<class T >
Foam::entry *	add (const keyType &k, const T &v, bool overwrite)

template<class T >
Foam::entry *	set (const keyType &k, const T &v)

Public Member Functions inherited from ILList< LListBase, T >
	ILList ()=default
	Null construct. More...

	ILList (T *item)
	Construct and insert the initial T item pointer. More...

	ILList (Istream &is)
	Construct from Istream. More...

	ILList (const ILList< LListBase, T > &lst)
	Copy construct using the 'clone()' method for each element. More...

	ILList (ILList< LListBase, T > &&lst)
	Move construct. More...

template<class CloneArg >
	ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone 'clone()'. More...

template<class INew >
	ILList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class. More...

	~ILList ()
	Destructor. More...

bool	eraseHead ()
	Remove the head element specified from the list and delete it. More...

bool	erase (T *item)
	Remove the specified element from the list and delete it. More...

void	clear ()
	Clear the contents of the list. More...

void	transfer (ILList< LListBase, T > &lst)

void	operator= (const ILList< LListBase, T > &lst)
	Copy assignment using the 'clone()' method for each element. More...

void	operator= (ILList< LListBase, T > &&lst)
	Move assignment. More...

Public Member Functions inherited from faSolution
	faSolution (const objectRegistry &obr)
	Construct from objectRegistry. More...

Public Member Functions inherited from solution
	solution (const objectRegistry &obr, const fileName &dictName)
	Construct for given objectRegistry and dictionary. More...

bool	cache (const word &name) const
	Return true if the given field should be cached. More...

bool	relaxField (const word &name) const
	Return true if the relaxation factor is given for the field. More...

bool	relaxEquation (const word &name) const
	Return true if the relaxation factor is given for the equation. More...

scalar	fieldRelaxationFactor (const word &name) const
	Return the relaxation factor for the given field. More...

scalar	equationRelaxationFactor (const word &name) const
	Return the relaxation factor for the given equation. More...

const dictionary &	solutionDict () const
	Return the selected sub-dictionary of solvers if the "select". More...

const dictionary &	solverDict (const word &name) const
	Return the solver controls dictionary for the given field. More...

const dictionary &	solver (const word &name) const
	Return the solver controls dictionary for the given field. More...

bool	read ()
	Read the solution dictionary. More...

Public Member Functions inherited from data
	data (const objectRegistry &obr)
	Construct for objectRegistry. More...

const dictionary &	solverPerformanceDict () const

template<class Type >
void	setSolverPerformance (const word &name, const SolverPerformance< Type > &sp) const
	Add/set the solverPerformance entry for the named field. More...

template<class Type >
void	setSolverPerformance (const SolverPerformance< Type > &sp) const
	Add/set the solverPerformance entry, using its fieldName. More...

Static Public Attributes
static word	meshSubDir = "faMesh"
	Return the mesh sub-directory name (usually "faMesh") More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

static int	maxFileModificationPolls

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static char	scopeSeparator
	Character for scoping object names (':' or '_') More...

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

Static Public Attributes inherited from faSchemes
static int	debug
	Debug switch. More...

Static Public Attributes inherited from dictionary
static int	writeOptionalEntries
	Report optional keywords and values if not present in dictionary. More...

static const dictionary	null
	An empty dictionary, which is also the parent for all dictionaries. More...

Static Public Attributes inherited from solution
static int	debug
	Debug switch. More...

Static Public Attributes inherited from data
static int	debug
	Debug switch. More...

Additional Inherited Members
Static Public Member Functions inherited from MeshObject< polyMesh, Foam::UpdateableMeshObject, faMesh >
static const faMesh &	New (const polyMesh &mesh, Args &&... args)
	Get existing or create a new MeshObject. More...

static bool	Delete (const polyMesh &mesh)
	Static destructor. More...

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

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

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

template<class Mesh , template< class > class FromType, template< class > class ToType>
static void	clearUpto (objectRegistry &obr)

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)

template<class Type >
static Type &	store (autoPtr< Type > &aptr)

template<class Type >
static Type &	store (autoPtr< Type > &&aptr)

template<class Type >
static Type &	store (tmp< Type > &tptr)

template<class Type >
static Type &	store (tmp< Type > &&tptr)

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 StringType >
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string. More...

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 StringType >
static word	scopedName (StringType scope, const word &name)
	Create scope:name or scope_name string. More...

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...

static Ostream &	writeBanner (Ostream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

Static Public Member Functions inherited from dictionary
static autoPtr< dictionary >	New (Istream &is)
	Construct top-level dictionary on freestore from Istream. More...

Static Public Member Functions inherited from solution
static label	upgradeSolverDict (dictionary &dict, const bool verbose=true)
	Update from older solver controls syntax. More...

template<class FieldType >
static void	cachePrintMessage (const char *message, const word &name, const FieldType &vf)
	Helper for printing cache message. More...

Public Attributes inherited from dictionary
friend	const_searcher
	Declare friendship with the searcher classes. More...

friend	searcher

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

Istream *	objectStream ()
	Construct and return an IFstream for the object. More...

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

Protected Member Functions inherited from edgeInterpolation
void	clearOut ()
	Clear all geometry and addressing. More...

Protected Attributes inherited from GeoMesh< polyMesh >
const polyMesh &	mesh_
	Reference to Mesh. More...

Protected Attributes inherited from MeshObject< polyMesh, Foam::UpdateableMeshObject, faMesh >
const polyMesh &	mesh_

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

Detailed Description

Finite area mesh. Used for 2-D non-Euclidian finite area method.

Source files

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Definition at line 77 of file faMesh.H.

Member Typedef Documentation

◆ Mesh

typedef faMesh Mesh

Definition at line 268 of file faMesh.H.

◆ BoundaryMesh

typedef faBoundaryMesh BoundaryMesh

Definition at line 269 of file faMesh.H.

Constructor & Destructor Documentation

◆ faMesh() [1/4]

faMesh ( const polyMesh & m )

explicit

Construct from polyMesh.

Definition at line 170 of file faMesh.C.

References IOobject::AUTO_WRITE, faBoundaryMesh::calcGeometry(), polyMesh::dbDir(), DebugInFunction, Foam::endl(), faMesh::globalData(), Foam::isFile(), faMesh::mesh(), faMesh::meshSubDir, IOobject::MUST_READ, UPstream::parRun(), objectRegistry::time(), faMesh::time(), timeName, Time::timePath(), and faBoundaryMesh::updateMesh().

Here is the call graph for this function:

◆ faMesh() [2/4]

faMesh	(	const polyMesh &	m,
		const labelList &	faceLabels
	)

Construct from components without boundary.

Boundary is added using addFaPatches() member function

Definition at line 259 of file faMesh.C.

References DebugInFunction, and Foam::endl().

Here is the call graph for this function:

◆ faMesh() [3/4]

faMesh	(	const polyMesh &	m,
		const fileName &	defFile
	)

Construct from finite area mesh definition file.

Definition at line 322 of file faMesh.C.

References Foam::abort(), LList< LListBase, T >::append(), IOobject::AUTO_WRITE, boundary, polyMesh::boundaryMesh(), DebugInFunction, primitiveMesh::edgeFaces(), Foam::endl(), polyMesh::faceOwner(), Foam::FatalError, FatalErrorInFunction, forAll, dictionary::get(), SortableList< T >::indices(), HashSet< Key, Hash >::insert(), Foam::isFile(), mesh, IOobject::MUST_READ, processorPolyPatch::myProcNo(), processorPolyPatch::neighbProcNo(), faPatch::New(), IOobject::NO_WRITE, UPstream::parRun(), Foam::foamVersion::patch, List< T >::setSize(), Foam::sort(), dictionary::subDict(), timeName, HashTable< T, Key, Hash >::toc(), and dictionary::toc().

Here is the call graph for this function:

◆ faMesh() [4/4]

faMesh	(	const polyMesh &	m,
		const label	polyPatchID
	)

Construct from polyPatch.

Definition at line 777 of file faMesh.C.

References dictionary::add(), boundary, polyMesh::boundaryMesh(), DebugInFunction, Foam::endl(), forAll, PrimitivePatch< FaceList, PointField >::nEdges(), faPatch::New(), PrimitivePatch< FaceList, PointField >::nInternalEdges(), Foam::foamVersion::patch, and polyBoundaryMesh::start().

Here is the call graph for this function:

◆ ~faMesh()

~faMesh ( )

virtual

Destructor.

Definition at line 883 of file faMesh.C.

Member Function Documentation

◆ TypeName()

TypeName ( "faMesh" )

Runtime type information.

◆ addFaPatches()

void addFaPatches ( const List< faPatch * > & p )

Add boundary patches. Constructor helper.

Definition at line 971 of file faMesh.C.

References Foam::abort(), boundary, DebugInFunction, Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, and p.

Here is the call graph for this function:

◆ mesh()

const polyMesh& mesh ( ) const

inline

Return access to polyMesh.

Definition at line 323 of file faMesh.H.

Referenced by faMesh::faMesh(), and faMesh::moving().

Here is the caller graph for this function:

◆ meshDir()

Foam::fileName meshDir ( ) const

Return the local mesh directory (dbDir()/meshSubDir)

Definition at line 891 of file faMesh.C.

References polyMesh::dbDir(), and mesh.

Here is the call graph for this function:

◆ time()

const Foam::Time & time ( ) const

Return reference to time.

Definition at line 897 of file faMesh.C.

References mesh, and fvMesh::time().

Referenced by faMesh::faMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pointsInstance()

const Foam::fileName & pointsInstance ( ) const

Return the current instance directory for points.

Used in the construction of geometric mesh data dependent on points

Definition at line 903 of file faMesh.C.

References mesh, and polyMesh::pointsInstance().

Here is the call graph for this function:

◆ facesInstance()

const Foam::fileName & facesInstance ( ) const

Return the current instance directory for faces.

Definition at line 909 of file faMesh.C.

References polyMesh::facesInstance(), and mesh.

Here is the call graph for this function:

◆ nPoints()

label nPoints ( ) const

inline

Definition at line 351 of file faMesh.H.

◆ nEdges()

label nEdges ( ) const

inline

Definition at line 356 of file faMesh.H.

◆ nInternalEdges()

label nInternalEdges ( ) const

inline

Definition at line 361 of file faMesh.H.

Referenced by faMesh::isInternalEdge(), faEdgeMapper::size(), and faMesh::updateMesh().

Here is the caller graph for this function:

◆ nFaces()

label nFaces ( ) const

inline

Definition at line 366 of file faMesh.H.

◆ points()

const Foam::pointField & points ( ) const

Return mesh points.

Definition at line 953 of file faMesh.C.

References Foam::foamVersion::patch.

◆ edges()

const Foam::edgeList & edges ( ) const

Return edges.

Definition at line 959 of file faMesh.C.

◆ faces()

const Foam::faceList & faces ( ) const

Return faces.

Definition at line 965 of file faMesh.C.

References Foam::foamVersion::patch.

◆ edgeOwner()

const labelList& edgeOwner ( ) const

inline

Edge owner addressing.

Definition at line 384 of file faMesh.H.

◆ edgeNeighbour()

const labelList& edgeNeighbour ( ) const

inline

Edge neighbour addressing.

Definition at line 390 of file faMesh.H.

◆ comm() [1/2]

Foam::label comm ( ) const

virtual

Return communicator used for parallel communication.

Implements lduMesh.

Definition at line 995 of file faMesh.C.

◆ comm() [2/2]

Foam::label & comm ( )

Return communicator used for parallel communication.

Definition at line 1001 of file faMesh.C.

◆ hasDb()

bool hasDb ( ) const

virtual

Return true if thisDb() is a valid DB.

Implements lduMesh.

Definition at line 1007 of file faMesh.C.

◆ thisDb()

const Foam::objectRegistry & thisDb ( ) const

virtual

Return reference to the mesh database.

Reimplemented from lduMesh.

Definition at line 1013 of file faMesh.C.

References mesh, and fvMesh::thisDb().

Here is the call graph for this function:

◆ name()

const word& name ( ) const

inline

Name function is needed to disambiguate those inherited.

from base classes

Definition at line 415 of file faMesh.H.

◆ boundary()

const Foam::faBoundaryMesh & boundary ( ) const

Return constant reference to boundary mesh.

Definition at line 1019 of file faMesh.C.

Referenced by interfaceTrackingFvMesh::correctUsBoundaryConditions(), and interfaceTrackingFvMesh::update().

Here is the caller graph for this function:

◆ faceLabels()

const labelList& faceLabels ( ) const

inline

Return faMesh face labels.

Definition at line 424 of file faMesh.H.

Referenced by faPatch::ngbPolyPatchFaces().

Here is the caller graph for this function:

◆ globalData()

const Foam::faGlobalMeshData & globalData ( ) const

Return parallel info.

Definition at line 1192 of file faMesh.C.

Referenced by faMesh::faMesh(), and faMesh::updateMesh().

Here is the caller graph for this function:

◆ lduAddr()

const Foam::lduAddressing & lduAddr ( ) const

virtual

Return ldu addressing.

Implements lduMesh.

Definition at line 1203 of file faMesh.C.

Referenced by faMesh::neighbour(), and faMesh::owner().

Here is the caller graph for this function:

◆ interfaces()

virtual lduInterfacePtrsList interfaces ( ) const

inlinevirtual

Return a list of pointers for each patch.

with only those pointing to interfaces being set

Implements lduMesh.

Definition at line 438 of file faMesh.H.

◆ owner()

const labelUList& owner ( ) const

inline

Internal face owner.

Definition at line 444 of file faMesh.H.

References faMesh::lduAddr(), and lduAddressing::lowerAddr().

Here is the call graph for this function:

◆ neighbour()

const labelUList& neighbour ( ) const

inline

Internal face neighbour.

Definition at line 450 of file faMesh.H.

References faMesh::lduAddr(), and lduAddressing::upperAddr().

Here is the call graph for this function:

◆ isInternalEdge()

bool isInternalEdge ( const label edgeIndex ) const

inline

Return true if given edge label is internal to the mesh.

Definition at line 456 of file faMesh.H.

References faMesh::nInternalEdges().

Here is the call graph for this function:

◆ moving()

bool moving ( ) const

inline

Is mesh moving.

Definition at line 465 of file faMesh.H.

References faMesh::mesh(), and polyMesh::moving().

Here is the call graph for this function:

◆ movePoints()

bool movePoints ( )

virtual

Update after mesh motion.

Implements MoveableMeshObject< polyMesh >.

Definition at line 1214 of file faMesh.C.

References DebugInfo, Foam::endl(), mesh, edgeInterpolation::movePoints(), IOobject::NO_READ, IOobject::NO_WRITE, polyMesh::points(), timeIndex, and timeName.

Here is the call graph for this function:

◆ updateMesh()

void updateMesh ( const mapPolyMesh & mpm )

virtual

Update after topo change.

Implements UpdateableMeshObject< polyMesh >.

Definition at line 38 of file faMeshUpdate.C.

References faMeshMapper::areaMap(), faBoundaryMesh::calcGeometry(), DebugInFunction, PrimitivePatch< FaceList, PointField >::edgeFaces(), Foam::endl(), forAll, HashTable< T, Key, Hash >::found(), faMesh::globalData(), faMesh::mapFields(), faMesh::mapOldAreas(), edgeInterpolation::movePoints(), PrimitivePatch< FaceList, PointField >::nEdges(), faAreaMapper::newFaceLabels(), faAreaMapper::newFaceLabelsMap(), PrimitivePatch< FaceList, PointField >::nInternalEdges(), faMesh::nInternalEdges(), faMeshMapper::oldPatchEdgeFaces(), UPstream::parRun(), faMesh::patch(), List< T >::setSize(), and faBoundaryMesh::updateMesh().

Here is the call graph for this function:

◆ mapFields()

void mapFields ( const faMeshMapper & mapper ) const

virtual

Map all fields in time using given map.

Definition at line 156 of file faMeshUpdate.C.

Referenced by faMesh::updateMesh().

Here is the caller graph for this function:

◆ mapOldAreas()

void mapOldAreas ( const faMeshMapper & mapper ) const

virtual

Map face areas in time using given map.

Definition at line 178 of file faMeshUpdate.C.

References faMeshMapper::areaMap(), DebugInFunction, Foam::endl(), Foam::faceMap(), forAll, and faAreaMapper::newFaceLabelsMap().

Referenced by faMesh::updateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patch() [1/2]

const Foam::indirectPrimitivePatch & patch ( ) const

Return constant reference to primitive patch.

Definition at line 915 of file faMesh.C.

References mesh, and points.

Referenced by faPatch::ngbPolyPatchFaces(), faMesh::updateMesh(), and interfaceTrackingFvMesh::writeVTK().

Here is the caller graph for this function:

◆ patch() [2/2]

Foam::indirectPrimitivePatch & patch ( )

Return reference to primitive patch.

Definition at line 934 of file faMesh.C.

References mesh, and points.

◆ patchStarts()

const Foam::labelList & patchStarts ( ) const

Return patch starts.

Definition at line 1025 of file faMesh.C.

◆ Le()

const Foam::edgeVectorField & Le ( ) const

Return edge length vectors.

Definition at line 1036 of file faMesh.C.

◆ magLe()

const Foam::edgeScalarField & magLe ( ) const

Return edge length magnitudes.

Definition at line 1047 of file faMesh.C.

◆ areaCentres()

const Foam::areaVectorField & areaCentres ( ) const

Return face centres as areaVectorField.

Definition at line 1058 of file faMesh.C.

Referenced by areaMesh::C().

Here is the caller graph for this function:

◆ edgeCentres()

const Foam::edgeVectorField & edgeCentres ( ) const

Return edge centres as edgeVectorField.

Definition at line 1069 of file faMesh.C.

Referenced by edgeMesh::C().

Here is the caller graph for this function:

◆ S()

const Foam::DimensionedField< Foam::scalar, Foam::areaMesh > & S ( ) const

Return face areas.

Definition at line 1081 of file faMesh.C.

Referenced by interfaceTrackingFvMesh::update().

Here is the caller graph for this function:

◆ S0()

const Foam::DimensionedField< Foam::scalar, Foam::areaMesh > & S0 ( ) const

Return old-time face areas.

Definition at line 1093 of file faMesh.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ S00()

const Foam::DimensionedField< Foam::scalar, Foam::areaMesh > & S00 ( ) const

Return old-old-time face areas.

Definition at line 1107 of file faMesh.C.

References IOobject::AUTO_WRITE, mesh, IOobject::NO_READ, IOobject::NO_WRITE, and timeName.

◆ faceAreaNormals()

const Foam::areaVectorField & faceAreaNormals ( ) const

Return face area normals.

Definition at line 1131 of file faMesh.C.

Referenced by interfaceTrackingFvMesh::freeSurfaceSnGradU(), interfaceTrackingFvMesh::surfaceTensionGrad(), and interfaceTrackingFvMesh::update().

Here is the caller graph for this function:

◆ edgeAreaNormals()

const Foam::edgeVectorField & edgeAreaNormals ( ) const

Return edge area normals.

Definition at line 1142 of file faMesh.C.

◆ pointAreaNormals()

const Foam::vectorField & pointAreaNormals ( ) const

Return point area normals.

Definition at line 1153 of file faMesh.C.

Referenced by faBoundaryMesh::calcGeometry().

Here is the caller graph for this function:

◆ faceCurvatures()

const Foam::areaScalarField & faceCurvatures ( ) const

Return face curvatures.

Definition at line 1169 of file faMesh.C.

Referenced by interfaceTrackingFvMesh::freeSurfacePressureJump(), and interfaceTrackingFvMesh::update().

Here is the caller graph for this function:

◆ edgeTransformTensors()

const Foam::FieldField< Foam::Field, Foam::tensor > & edgeTransformTensors ( ) const

Return edge transformation tensors.

Definition at line 1181 of file faMesh.C.

◆ internalPoints()

Foam::labelList internalPoints ( ) const

Return internal point labels.

Definition at line 848 of file faMeshDemandDrivenData.C.

References LList< LListBase, T >::append(), DebugInFunction, Foam::endl(), forAll, nPoints, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ boundaryPoints()

Foam::labelList boundaryPoints ( ) const

Return boundary point labels.

Definition at line 881 of file faMeshDemandDrivenData.C.

References LList< LListBase, T >::append(), DebugInFunction, Foam::endl(), forAll, nPoints, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ edgeLengthCorrection()

Foam::tmp< Foam::edgeScalarField > edgeLengthCorrection ( ) const

Return edge length correction.

Definition at line 1808 of file faMeshDemandDrivenData.C.

References Foam::constant::atomic::alpha, Foam::asin(), boundary, Foam::correction(), Foam::cos(), DebugInFunction, Foam::dimless, stdFoam::end(), Foam::endl(), forAll, Foam::mag(), mesh, and tmp< T >::ref().

Here is the call graph for this function:

◆ correctPatchPointNormals() [1/2]

bool correctPatchPointNormals ( const label patchID ) const

Whether point normals should be corrected for a patch.

Definition at line 1276 of file faMesh.C.

References Foam::abort(), boundary, Foam::FatalError, FatalErrorInFunction, and patchID.

Here is the call graph for this function:

◆ correctPatchPointNormals() [2/2]

Foam::boolList & correctPatchPointNormals ( ) const

Set whether point normals should be corrected for a patch.

Definition at line 1294 of file faMesh.C.

References boundary.

◆ write()

bool write ( const bool valid = true ) const

virtual

Write mesh.

Reimplemented from regIOobject.

Definition at line 1305 of file faMesh.C.

◆ operator!=()

bool operator!= ( const faMesh & m ) const

Definition at line 1316 of file faMesh.C.

◆ operator==()

bool operator== ( const faMesh & m ) const

Definition at line 1322 of file faMesh.C.

Member Data Documentation

◆ meshSubDir

Foam::word meshSubDir = "faMesh"

static

Return the mesh sub-directory name (usually "faMesh")

Definition at line 277 of file faMesh.H.

Referenced by faMesh::faMesh().

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

src/finiteArea/faMesh/faMesh.H
src/finiteArea/faMesh/faMesh.C
src/finiteArea/faMesh/faMeshDemandDrivenData.C
src/finiteArea/faMesh/faMeshUpdate.C

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Mesh

◆ BoundaryMesh

Constructor & Destructor Documentation

◆ faMesh() [1/4]

◆ faMesh() [2/4]

◆ faMesh() [3/4]

◆ faMesh() [4/4]

◆ ~faMesh()

Member Function Documentation

◆ TypeName()

◆ addFaPatches()

◆ mesh()

◆ meshDir()

◆ time()

◆ pointsInstance()

◆ facesInstance()

◆ nPoints()

◆ nEdges()

◆ nInternalEdges()

◆ nFaces()

◆ points()

◆ edges()

◆ faces()

◆ edgeOwner()

◆ edgeNeighbour()

◆ comm() [1/2]

◆ comm() [2/2]

◆ hasDb()

◆ thisDb()

◆ name()

◆ boundary()

◆ faceLabels()

◆ globalData()

◆ lduAddr()

◆ interfaces()

◆ owner()

◆ neighbour()

◆ isInternalEdge()

◆ moving()

◆ movePoints()

◆ updateMesh()

◆ mapFields()

◆ mapOldAreas()

◆ patch() [1/2]

◆ patch() [2/2]

◆ patchStarts()

◆ Le()

◆ magLe()

◆ areaCentres()

◆ edgeCentres()

◆ S()

◆ S0()

◆ S00()

◆ faceAreaNormals()

◆ edgeAreaNormals()

◆ pointAreaNormals()

◆ faceCurvatures()

◆ edgeTransformTensors()

◆ internalPoints()

◆ boundaryPoints()

◆ edgeLengthCorrection()

◆ correctPatchPointNormals() [1/2]

◆ correctPatchPointNormals() [2/2]

◆ write()

◆ operator!=()

◆ operator==()

Member Data Documentation

◆ meshSubDir