Finite area boundary mesh. More...

Inheritance diagram for faBoundaryMesh:

Collaboration diagram for faBoundaryMesh:

Public Member Functions
	TypeName ("faBoundaryMesh")

	faBoundaryMesh (const IOobject &io, const faMesh &fam)

	faBoundaryMesh (const IOobject &io, const faMesh &fam, const label size)

	~faBoundaryMesh ()=default

const faMesh &	mesh () const noexcept

UPtrList< const labelUList >	edgeFaces () const

lduInterfacePtrsList	interfaces () const

label	nNonProcessor () const

wordList	names () const

wordList	types () const

labelList	patchStarts () const

labelList	patchSizes () const

List< labelRange >	patchRanges () const

label	start () const

label	nEdges () const

labelRange	range () const

labelList	indices (const wordRe &matcher, const bool useGroups=true) const

labelList	indices (const wordRes &matcher, const bool useGroups=true) const

label	findIndex (const wordRe &key) const

label	findPatchID (const word &patchName) const

label	whichPatch (const label edgeIndex) const

bool	checkDefinition (const bool report=false) const

void	calcGeometry ()

void	movePoints (const pointField &)

void	updateMesh ()

bool	writeData (Ostream &os) const

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const

labelList	findIndices (const wordRe &key, bool useGroups=true) const

Public Member Functions inherited from PtrList
constexpr	PtrList () noexcept

	PtrList (const label len)

	PtrList (const PtrList< T > &list)

	PtrList (PtrList< T > &&list)

	PtrList (UList< T * > &list)

template<class CloneArg >
	PtrList (const PtrList< T > &list, const CloneArg &cloneArgs)

	PtrList (PtrList< T > &list, bool reuse)

	PtrList (const SLPtrList< T > &list)

template<class INew >
	PtrList (Istream &is, const INew &inew)

	PtrList (Istream &is)

	~PtrList ()

template<class... Args>
PtrList< T >	clone (Args &&... args) const

const T *	set (const label i) const

void	clear ()

void	resize (const label newLen)

void	setSize (const label newLen)

template<class... Args>
void	emplace_append (Args &&... args)

void	append (T *ptr)

void	append (autoPtr< T > &ptr)

void	append (autoPtr< T > &&ptr)

void	append (std::unique_ptr< T > &&ptr)

void	append (const refPtr< T > &ptr)

void	append (const tmp< T > &ptr)

template<class... Args>
autoPtr< T >	emplace (const label i, Args &&... args)

autoPtr< T >	set (const label i, T *ptr)

autoPtr< T >	set (const label i, autoPtr< T > &ptr)

autoPtr< T >	set (const label i, autoPtr< T > &&ptr)

autoPtr< T >	set (const label i, std::unique_ptr< T > &&ptr)

autoPtr< T >	set (const label i, const refPtr< T > &ptr)

autoPtr< T >	set (const label i, const tmp< T > &ptr)

autoPtr< T >	release (const label i)

void	transfer (PtrList< T > &list)

void	operator= (const PtrList< T > &list)

void	operator= (PtrList< T > &&list)

template<class T >
	PtrList (PtrList< T > &list, bool reuse)

template<class T >
	PtrList (const SLPtrList< T > &list)

template<class... Args>
Foam::PtrList< T >	clone (Args &&... args) const

template<class T >
constexpr	PtrList () noexcept

template<class T >
	PtrList (const label len)

template<class T >
	PtrList (const PtrList< T > &list)

template<class T >
	PtrList (PtrList< T > &&list)

template<class T >
	PtrList (UList< T * > &list)

template<class... Args>
Foam::autoPtr< T >	emplace (const label i, Args &&... args)

template<class T >
	PtrList (Istream &is)

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")

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

	regIOobject (const regIOobject &rio)

	regIOobject (const regIOobject &rio, bool registerCopy)

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

	regIOobject (const IOobject &io, const regIOobject &rio)

virtual	~regIOobject ()

bool	checkIn ()

bool	checkOut ()

virtual void	addWatch ()

bool	ownedByRegistry () const

bool	store ()

void	release (const bool unregister=false)

label	eventNo () const

label &	eventNo ()

bool	upToDate (const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const

void	setUpToDate ()

virtual void	rename (const word &newName)

const dictionary *	findMetaData () const noexcept

dictionary &	getMetaData () noexcept

void	removeMetaData ()

virtual void	updateMetaData ()

virtual fileName	filePath () const

bool	headerOk ()

Istream &	readStream (const word &, const bool valid=true)

void	close ()

virtual bool	readData (Istream &)

virtual bool	read ()

virtual label	addWatch (const fileName &)

const labelList &	watchIndices () const

labelList &	watchIndices ()

virtual bool	modified () const

virtual bool	readIfModified ()

virtual bool	write (const bool valid=true) const

virtual bool	global () const

void	operator= (const IOobject &io)

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const

Public Member Functions inherited from IOobject
	TypeName ("IOobject")

	IOobject (const IOobject &)=default

virtual	~IOobject ()=default

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	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)

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const IOobject &io, const objectRegistry &registry)

	IOobject (const IOobject &io, const word &name)

	IOobject (const IOobject &io, readOption, writeOption)

autoPtr< IOobject >	clone () const

autoPtr< IOobject >	clone (const objectRegistry &registry) const

const objectRegistry &	db () const noexcept

const Time &	time () const

const word &	name () const noexcept

const word &	headerClassName () const noexcept

word &	headerClassName () noexcept

const string &	note () const noexcept

string &	note () noexcept

bool	registerObject () const noexcept

bool	registerObject (bool on) noexcept

bool	globalObject () const noexcept

bool	globalObject (bool on) noexcept

unsigned	labelByteSize () const noexcept

unsigned	scalarByteSize () const noexcept

bool	isHeaderClassName (const word &clsName) const

template<class Type >
bool	isHeaderClassName () const

readOption	readOpt () const noexcept

readOption	readOpt (readOption opt) noexcept

writeOption	writeOpt () const noexcept

writeOption	writeOpt (writeOption opt) noexcept

word	group () const

word	member () const

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

fileName	path () const

fileName	path (const word &instance, const fileName &local=fileName::null) const

fileName	objectPath () const

fileName	objectRelPath () const

fileName	localFilePath (const word &typeName, const bool search=true) const

fileName	globalFilePath (const word &typeName, const bool search=true) const

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)

template<class Type >
void	warnNoRereading () const

bool	writeHeader (Ostream &os) const

bool	writeHeader (Ostream &os, const word &objectType) const

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept

bool	bad () const noexcept

InfoProxy< IOobject >	info () const

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept

writeOption &	writeOpt () noexcept

bool &	registerObject () noexcept

bool &	globalObject () noexcept

template<>
bool	isHeaderClassName () const

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

Friends
Ostream &	operator<< (Ostream &, const faBoundaryMesh &)

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }

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

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

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

template<class Type >
static Type &	store (refPtr< Type > &ptr)

template<class Type >
static Type &	store (refPtr< Type > &&ptr)

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

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

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept

static bool	bannerEnabled (bool on) noexcept

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)

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

static word	group (const word &name)

static word	member (const word &name)

static word	scopedName (const std::string &scope, const word &name)

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)

static Ostream &	writeDivider (Ostream &os)

static Ostream &	writeEndDivider (Ostream &os)

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames

static char	scopeSeparator

static fileCheckTypes	fileModificationChecking

static float	fileModificationSkew

static int	maxFileModificationPolls

Protected Member Functions inherited from PtrList
template<class INew >
void	readIstream (Istream &is, const INew &inew)

void	free ()

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)

Protected Member Functions inherited from IOobject
void	setBad (const string &s)

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false

Detailed Description

Finite area boundary mesh.

Source files

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Definition at line 61 of file faBoundaryMesh.H.

Constructor & Destructor Documentation

◆ faBoundaryMesh() [1/2]

faBoundaryMesh	(	const IOobject &	io,
		const faMesh &	fam
	)

Definition at line 62 of file faBoundaryMesh.C.

References IOstream::check(), dict, forAll, FUNCTION_NAME, Foam::New(), and patches.

Here is the call graph for this function:

◆ faBoundaryMesh() [2/2]

faBoundaryMesh	(	const IOobject &	io,
		const faMesh &	fam,
		const label	size
	)

Definition at line 111 of file faBoundaryMesh.C.

◆ ~faBoundaryMesh()

~faBoundaryMesh ( )

default

Member Function Documentation

◆ TypeName()

TypeName ( "faBoundaryMesh" )

◆ mesh()

const faMesh& mesh ( ) const

inlinenoexcept

Definition at line 121 of file faBoundaryMesh.H.

Referenced by wedgeFaPatch::wedgeFaPatch().

Here is the caller graph for this function:

◆ edgeFaces()

Foam::UPtrList< const Foam::labelUList > edgeFaces ( ) const

Definition at line 146 of file faBoundaryMesh.C.

References forAll, patches, and UPtrList::set().

Referenced by interfaceTrackingFvMesh::update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interfaces()

Foam::lduInterfacePtrsList interfaces ( ) const

Definition at line 161 of file faBoundaryMesh.C.

References forAll, patches, and UPtrList::set().

Referenced by faMesh::interfaces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nNonProcessor()

Foam::label nNonProcessor ( ) const

Definition at line 181 of file faBoundaryMesh.C.

References p, and patches.

◆ names()

Foam::wordList names ( ) const

Definition at line 201 of file faBoundaryMesh.C.

◆ types()

Foam::wordList types ( ) const

Definition at line 207 of file faBoundaryMesh.C.

◆ patchStarts()

Foam::labelList patchStarts ( ) const

Definition at line 213 of file faBoundaryMesh.C.

References forAll, and patches.

Referenced by faFieldDecomposer::reset().

Here is the caller graph for this function:

◆ patchSizes()

Foam::labelList patchSizes ( ) const

Definition at line 232 of file faBoundaryMesh.C.

References p.

◆ patchRanges()

Foam::List< Foam::labelRange > patchRanges ( ) const

Definition at line 243 of file faBoundaryMesh.C.

References forAll, and patches.

◆ start()

Foam::label start ( ) const

Definition at line 260 of file faBoundaryMesh.C.

Referenced by faBoundaryMesh::checkDefinition().

Here is the caller graph for this function:

◆ nEdges()

Foam::label nEdges ( ) const

Definition at line 266 of file faBoundaryMesh.C.

◆ range()

Foam::labelRange range ( ) const

Definition at line 272 of file faBoundaryMesh.C.

◆ indices() [1/2]

Foam::labelList indices	(	const wordRe &	matcher,
		const bool	useGroups = `true`
	)		const

Parameters

useGroups currently ignored

Definition at line 279 of file faBoundaryMesh.C.

References Foam::PtrListOps::findMatching(), Foam::PtrListOps::firstMatching(), wordRe::isPattern(), and patchId().

Referenced by faBoundaryMesh::findIndices().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ indices() [2/2]

Foam::labelList indices	(	const wordRes &	matcher,
		const bool	useGroups = `true`
	)		const

Parameters

useGroups currently ignored

Definition at line 311 of file faBoundaryMesh.C.

References Foam::PtrListOps::findMatching().

Here is the call graph for this function:

◆ findIndex()

Foam::label findIndex ( const wordRe & key ) const

Definition at line 329 of file faBoundaryMesh.C.

References Foam::PtrListOps::firstMatching(), and Foam::glTF::key().

Here is the call graph for this function:

◆ findPatchID()

Foam::label findPatchID ( const word & patchName ) const

Definition at line 339 of file faBoundaryMesh.C.

References Foam::PtrListOps::firstMatching().

Referenced by interfaceTrackingFvMesh::update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ whichPatch()

Foam::label whichPatch ( const label edgeIndex ) const

Definition at line 350 of file faBoundaryMesh.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, mesh, and primitiveMesh::nEdges().

Here is the call graph for this function:

◆ checkDefinition()

bool checkDefinition ( const bool report = false ) const

Definition at line 392 of file faBoundaryMesh.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), forAll, Foam::Info, InfoInFunction, mesh, IOobject::name(), primitiveMesh::nInternalEdges(), SeriousErrorInFunction, and faBoundaryMesh::start().

Here is the call graph for this function:

◆ calcGeometry()

void calcGeometry ( )

Definition at line 125 of file faBoundaryMesh.C.

References forAll, and faMesh::pointAreaNormals().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ movePoints()

void movePoints ( const pointField & p )

Definition at line 439 of file faBoundaryMesh.C.

References forAll, polyBoundaryMesh::movePoints(), p, and patches.

Here is the call graph for this function:

◆ updateMesh()

void updateMesh ( )

Definition at line 461 of file faBoundaryMesh.C.

References forAll, patches, and polyBoundaryMesh::updateMesh().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Implements regIOobject.

Definition at line 477 of file faBoundaryMesh.C.

References token::BEGIN_LIST, Ostream::beginBlock(), IOstream::check(), Foam::decrIndent(), token::END_LIST, Ostream::endBlock(), FUNCTION_NAME, IOstream::good(), Foam::incrIndent(), Foam::nl, os(), p, and patches.

Referenced by Foam::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeObject()

bool writeObject	(	IOstreamOption	streamOpt,
		const bool	valid
	)		const

virtual

Reimplemented from regIOobject.

Definition at line 498 of file faBoundaryMesh.C.

References regIOobject::writeObject().

Here is the call graph for this function:

◆ findIndices()

labelList findIndices	(	const wordRe &	key,
		bool	useGroups = `true`
	)		const

inline

Definition at line 229 of file faBoundaryMesh.H.

References faBoundaryMesh::indices(), and Foam::glTF::key().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<<	(	Ostream &	,
		const faBoundaryMesh &
	)

friend

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

src/finiteArea/faMesh/faBoundaryMesh/faBoundaryMesh.H
src/finiteArea/faMesh/faBoundaryMesh/faBoundaryMesh.C

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ faBoundaryMesh() [1/2]

◆ faBoundaryMesh() [2/2]

◆ ~faBoundaryMesh()

Member Function Documentation

◆ TypeName()

◆ mesh()

◆ edgeFaces()

◆ interfaces()

◆ nNonProcessor()

◆ names()

◆ types()

◆ patchStarts()

◆ patchSizes()

◆ patchRanges()

◆ start()

◆ nEdges()

◆ range()

◆ indices() [1/2]

◆ indices() [2/2]

◆ findIndex()

◆ findPatchID()

◆ whichPatch()

◆ checkDefinition()

◆ calcGeometry()

◆ movePoints()

◆ updateMesh()

◆ writeData()

◆ writeObject()

◆ findIndices()

Friends And Related Function Documentation

◆ operator<<