A surface mesh consisting of general polygon faces and capable of holding fields. More...

Inheritance diagram for polySurface:

Collaboration diagram for polySurface:

Public Types
enum	FieldAssociation { NO_DATA = 0, FACE_DATA = 1, POINT_DATA = 2, FACE_OR_POINT_DATA = 3 }
	Enumeration for the field association. More...

typedef polySurface	Mesh
	Typedef required for GeoMesh. More...

typedef bool	BoundaryMesh
	Placeholder only, for GeoMesh. More...

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 HashTable< regIOobject * >
typedef HashTable< regIOobject *, word, Foam::Hash< word > >	this_type
	The template instance used for this HashTable. More...

typedef word	key_type
	The second template parameter, type of keys used. More...

typedef regIOobject *	mapped_type
	The first template parameter, type of objects contained. More...

typedef regIOobject *	value_type
	Same as mapped_type for OpenFOAM HashTables. More...

typedef Foam::Hash< word >	hasher
	The third template parameter, the hash index method. More...

typedef regIOobject * *	pointer
	Pointer type for storing into value_type objects. More...

typedef regIOobject * &	reference
	Reference to the stored value_type. More...

typedef label	difference_type
	The type to represent the difference between two iterators. More...

typedef label	size_type
	The type that can represent the size of a HashTable. More...

using	key_iterator = key_iterator_base< iterator >
	Forward iterator returning the key. More...

using	const_key_iterator = key_iterator_base< const_iterator >
	Forward const iterator returning the key. More...

Public Types inherited from PrimitivePatch<::Foam::List< face >, pointField >
enum	surfaceTopo
	Enumeration defining the surface type. Used in check routines. More...

typedef std::remove_reference< ::Foam::List< face > >::type::value_type	face_type
	The face type. More...

typedef std::remove_reference< pointField >::type::value_type	point_type
	The point type. More...

typedef ::Foam::List< face >	FaceListType
	The face list type. More...

typedef pointField	PointFieldType
	The point field type. More...

typedef face_type	FaceType
	Deprecated(2020-03) prefer face_type typedef. More...

Public Types inherited from List< face >
typedef SubList< face >	subList
	Declare type of subList. More...

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

	polySurface (const IOobject &io, bool doCheckIn=false)

	polySurface (const word &surfName, const objectRegistry &obr, bool doCheckIn=false)

	polySurface (const IOobject &io, const MeshedSurface< face > &surf, bool doCheckIn=false)

	polySurface (const IOobject &io, MeshedSurface< face > &&surf, bool doCheckIn=false)

virtual	~polySurface ()
	Destructor. More...

virtual label	nPoints () const
	Return the number of points. More...

virtual label	nFaces () const
	Return the number of faces. More...

virtual label	size () const
	Return number of faces. More...

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

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

virtual const labelList &	zoneIds () const
	Const access to per-face zone/region information (demand-driven) More...

const vectorField &	Sf () const
	Return face area vectors (normals) More...

const scalarField &	magSf () const
	Return face area magnitudes. More...

const vectorField &	Cf () const
	Face centres. More...

void	copySurface (const pointField &points, const faceList &faces, bool unused=false)
	Update with new contents. More...

void	copySurface (const meshedSurf &surf, bool unused=false)
	Update with new contents. More...

void	copySurface (const MeshedSurface< face > &surf, bool unused=false)
	Update with new contents. More...

void	transfer (pointField &&points, faceList &&faces, labelList &&zoneIds=labelList())
	Transfer the contents of the argument and annul the argument. More...

void	transfer (MeshedSurface< face > &surf, bool validate=false)
	Transfer the contents of the argument and annul the argument. More...

label	nFaceData () const
	Number of main entries, without PointData sub-registry. More...

label	nPointData () const
	Number of entries on PointData sub-registry (if it exists) More...

FieldAssociation	queryFieldAssociation (const word &fieldName) const
	Query the field association (FACE or POINT) More...

const regIOobject *	findFieldObject (const word &fieldName, const FieldAssociation association) const

template<class GeoMeshType = void>
const regIOobject *	findFieldObject (const word &fieldName) const
	General finding of the field object (FACE or POINT) More...

template<class GeoMeshType = void>
const objectRegistry *	whichRegistry (const word &fieldName) const

template<class DataType >
const objectRegistry &	fieldData () const
	Regular data are stored directly on the registry. More...

const objectRegistry &	faceData () const
	Face data are stored directly on the registry. More...

const objectRegistry &	pointData () const
	Point data are stored in a sub-registry. More...

template<class Type , class GeoMeshType = polySurfaceGeoMesh>
void	storeField (const word &fieldName, const dimensionSet &dims, const Field< Type > &values)
	Copy/store named field as face or point data (template parameter). More...

template<class Type , class GeoMeshType = polySurfaceGeoMesh>
void	storeField (const word &fieldName, const dimensionSet &dims, Field< Type > &&values)
	Move/store named field as face or point data (template parameter). More...

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write - this is a no-op. More...

void	clearGeom ()
	Clear geometry. More...

void	clearAddressing ()
	Clear addressing. More...

void	clearOut ()
	Clear all geometry and addressing unnecessary for CFD. More...

void	clearPrimitives ()
	Clear primitive data (points, faces and cells) More...

void	clearFields ()
	Clear stored fields. More...

template<>
const regIOobject *	findFieldObject (const word &fieldName) const

template<>
const regIOobject *	findFieldObject (const word &fieldName) const

template<>
const objectRegistry *	whichRegistry (const word &fieldName) const

template<>
const objectRegistry *	whichRegistry (const word &fieldName) const

template<>
const regIOobject *	findFieldObject (const word &fieldName) const
	Find face field object (on main registry). More...

template<>
const regIOobject *	findFieldObject (const word &fieldName) const
	Find point field object (on sub-registry) More...

template<>
const objectRegistry *	whichRegistry (const word &fieldName) const

template<>
const objectRegistry *	whichRegistry (const word &fieldName) const
	Point data field found on sub-registry? More...

template<>
const objectRegistry &	fieldData () const
	Point data are stored in a sub-registry. More...

template<class GeoMeshType >
const Foam::regIOobject *	findFieldObject (const word &fieldName) const

template<class GeoMeshType >
const Foam::objectRegistry *	whichRegistry (const word &fieldName) const

Public Member Functions inherited from objectRegistry
	TypeName ("objectRegistry")
	Declare type name for this IOobject. More...

	objectRegistry (const Time &db, const label nObjects=128)

	objectRegistry (const IOobject &io, const label nObjects=128)

virtual	~objectRegistry ()
	Destructor, with checkOut() for all objects that are ownedByRegistry. More...

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

const objectRegistry &	parent () const noexcept
	Return the parent objectRegistry. More...

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

bool	isTimeDb () const noexcept
	True if the registry is Time. More...

virtual const fileName &	dbDir () const
	Local directory path of this objectRegistry relative to the time. More...

HashTable< wordHashSet >	classes () const
	A summary hash of classes used and their associated object names. More...

template<class MatchPredicate >
HashTable< wordHashSet >	classes (const MatchPredicate &matchName) const

label	count (const char *clsName) const
	The number of objects of the given class name. More...

template<class MatchPredicate >
label	count (const MatchPredicate &matchClass) const
	The number of objects of the given class name. More...

template<class MatchPredicate1 , class MatchPredicate2 >
label	count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
	The number of objects of the given class name. More...

template<class Type >
label	count (const bool strict=false) const
	The names of objects with a class satisfying `isA<Type>` More...

template<class Type , class MatchPredicate >
label	count (const MatchPredicate &matchName) const

wordList	names () const
	The names of all objects. More...

wordList	names (const char *clsName) const
	The names of objects with the given class name. More...

template<class MatchPredicate >
wordList	names (const MatchPredicate &matchClass) const
	The names of objects with a matching class name. More...

template<class MatchPredicate1 , class MatchPredicate2 >
wordList	names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const

template<class Type >
wordList	names () const
	The names of objects with a class satisfying `isA<Type>`. More...

template<class Type , class MatchPredicate >
wordList	names (const MatchPredicate &matchName) const

wordList	sortedNames () const
	The sorted names of all objects. More...

wordList	sortedNames (const char *clsName) const
	The sorted names of objects with the given class name. More...

template<class MatchPredicate >
wordList	sortedNames (const MatchPredicate &matchClass) const
	The sorted names objects with a matching class name. More...

template<class MatchPredicate1 , class MatchPredicate2 >
wordList	sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const

template<class Type >
wordList	sortedNames () const
	The sorted names of objects with a class satisfying `isA<Type>` More...

template<class Type , class MatchPredicate >
wordList	sortedNames (const MatchPredicate &matchName) const

const objectRegistry &	subRegistry (const word &name, const bool forceCreate=false, const bool recursive=false) const
	Lookup and return a const sub-objectRegistry. More...

template<class Type >
HashTable< const Type * >	lookupClass (const bool strict=false) const
	Return all objects with a class satisfying `isA<Type>` More...

template<class Type >
HashTable< Type * >	lookupClass (const bool strict=false)
	Return all objects with a class satisfying `isA<Type>` More...

const regIOobject *	cfindIOobject (const word &name, const bool recursive=false) const
	Return const pointer to the regIOobject. More...

bool	found (const word &name, const bool recursive=false) const
	Can the regIOobject object be found (by name). More...

template<class Type >
bool	foundObject (const word &name, const bool recursive=false) const
	Is the named Type found? More...

template<class Type >
const Type *	cfindObject (const word &name, const bool recursive=false) const
	Return const pointer to the object of the given Type. More...

template<class Type >
const Type *	findObject (const word &name, const bool recursive=false) const
	Return const pointer to the object of the given Type. More...

template<class Type >
Type *	findObject (const word &name, const bool recursive=false)
	Return non-const pointer to the object of the given Type. More...

template<class Type >
Type *	getObjectPtr (const word &name, const bool recursive=false) const

template<class Type >
const Type &	lookupObject (const word &name, const bool recursive=false) const

template<class Type >
Type &	lookupObjectRef (const word &name, const bool recursive=false) const

label	getEvent () const
	Return new event number. More...

bool	checkIn (regIOobject *io) const
	Add a regIOobject to registry. A nullptr is ignored. More...

bool	checkIn (regIOobject &io) const
	Add a regIOobject to registry. More...

bool	checkOut (regIOobject *io) const

bool	checkOut (regIOobject &io) const

bool	checkOut (const word &key) const

void	clear ()
	Clear all entries from the registry. More...

void	clearStorage ()
	Clear all entries from the registry and the table itself. More...

bool	erase (const iterator &iter)
	Erase an entry specified by the given iterator. More...

bool	erase (const word &key)
	Erase an entry specified by the given key. More...

label	erase (std::initializer_list< word > keys)
	Remove entries given by the listed keys. More...

label	erase (const UList< word > &keys)
	Remove entries given by the listed keys. More...

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

virtual bool	modified () const
	Return true if any of the object's files have been modified. More...

void	readModifiedObjects ()
	Read the objects that have been modified. More...

virtual bool	readIfModified ()
	Read object if modified. More...

virtual bool	writeData (Ostream &) const
	writeData function required by regIOobject but not used. More...

template<class Type >
const Type *	lookupObjectPtr (const word &name, bool recursive=false) const
	Deprecated(2018-10) find object. More...

template<class Type >
Type *	lookupObjectRefPtr (const word &name, bool recursive=false) const
	Deprecated(2018-10) get object pointer, ignoring constness. More...

template<class MatchPredicate >
Foam::HashTable< Foam::wordHashSet >	classesImpl (const objectRegistry &list, const MatchPredicate &matchName)

template<class MatchPredicate1 , class MatchPredicate2 >
Foam::label	countImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName)

template<class Type , class MatchPredicate >
Foam::label	countTypeImpl (const objectRegistry &list, const MatchPredicate &matchName)

template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList	namesImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName, const bool doSort)

template<class Type , class MatchPredicate >
Foam::wordList	namesTypeImpl (const objectRegistry &list, const MatchPredicate &matchName, const bool doSort)

template<class MatchPredicate >
Foam::HashTable< Foam::wordHashSet >	classes (const MatchPredicate &matchName) const

template<class MatchPredicate >
Foam::label	count (const MatchPredicate &matchClass) const

template<class MatchPredicate1 , class MatchPredicate2 >
Foam::label	count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const

template<class Type , class MatchPredicate >
Foam::label	count (const MatchPredicate &matchName) const

template<class Type >
Foam::label	count (const bool strict) const

template<class MatchPredicate >
Foam::wordList	names (const MatchPredicate &matchClass) const

template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList	names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const

template<class Type >
Foam::wordList	names () const

template<class Type , class MatchPredicate >
Foam::wordList	names (const MatchPredicate &matchName) const

template<class MatchPredicate >
Foam::wordList	sortedNames (const MatchPredicate &matchClass) const

template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList	sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const

template<class Type >
Foam::wordList	sortedNames () const

template<class Type , class MatchPredicate >
Foam::wordList	sortedNames (const MatchPredicate &matchName) const

template<class Type >
Foam::HashTable< const Type * >	lookupClass (const bool strict) const

template<class Type >
Foam::HashTable< Type * >	lookupClass (const bool strict)

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

	regIOobject (const IOobject &io, const bool isTimeObject=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...

const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...

dictionary &	getMetaData () noexcept
	Get or create meta-data. More...

void	removeMetaData ()
	Remove meta-data. More...

virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) 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 valid=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...

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	write (const bool valid=true) const
	Write using setting from DB. More...

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

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

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::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, bool globalObject=false)
	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...

	IOobject (const IOobject &io, readOption, writeOption)
	Copy construct, resetting io options. More...

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

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

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

const Time &	time () const
	Return Time associated with the objectRegistry. More...

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

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

word &	headerClassName () noexcept
	Return non-constant access to the class name read from header. More...

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

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

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

bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...

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

bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, 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 noexcept
	The read option. More...

readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...

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

writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. 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 noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

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	objectRelPath () const
	The object path relative to the root. 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...

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)
	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 with current type() More...

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

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
	Return info proxy. More...

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept
	Access to the read option. More...

writeOption &	writeOpt () noexcept
	Access to the write option. More...

bool &	registerObject () noexcept
	Access to the register object option. More...

bool &	globalObject () noexcept
	Access to the global object option. More...

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)

Public Member Functions inherited from HashTable< regIOobject * >
	HashTable ()
	Default construct with default (128) table capacity. More...

	HashTable (const label size)
	Construct given initial table capacity. More...

	HashTable (Istream &is, const label size=128)
	Construct from Istream with default table capacity. More...

	HashTable (const this_type &ht)
	Copy construct. More...

	HashTable (this_type &&rhs)
	Move construct. More...

	HashTable (std::initializer_list< std::pair< word, regIOobject * >> list)
	Construct from an initializer list. More...

	~HashTable ()
	Destructor. More...

label	capacity () const noexcept
	The size of the underlying table. More...

label	size () const noexcept
	The number of elements in table. More...

bool	empty () const noexcept
	True if the hash table is empty. More...

regIOobject * &	at (const word &key)
	Find and return a hashed entry. FatalError if it does not exist. More...

const regIOobject * &	at (const word &key) const
	Find and return a hashed entry. FatalError if it does not exist. More...

bool	found (const word &key) const
	Return true if hashed entry is found in table. More...

iterator	find (const word &key)
	Find and return an iterator set at the hashed entry. More...

const_iterator	find (const word &key) const
	Find and return an const_iterator set at the hashed entry. More...

const_iterator	cfind (const word &key) const
	Find and return an const_iterator set at the hashed entry. More...

const regIOobject * &	lookup (const word &key, const regIOobject * &deflt) const
	Return hashed entry if it exists, or return the given default. More...

List< word >	toc () const
	The table of contents (the keys) in unsorted order. More...

List< word >	sortedToc () const
	The table of contents (the keys) in sorted order. More...

List< word >	sortedToc (const Compare &comp) const

Foam::List< word >	sortedToc (const Compare &comp) const

List< word >	tocKeys (const UnaryPredicate &pred, const bool invert=false) const

Foam::List< word >	tocKeys (const UnaryPredicate &pred, const bool invert) const

List< word >	tocValues (const UnaryPredicate &pred, const bool invert=false) const

Foam::List< word >	tocValues (const UnaryPredicate &pred, const bool invert) const

List< word >	tocEntries (const BinaryPredicate &pred, const bool invert=false) const

Foam::List< word >	tocEntries (const BinaryPredicate &pred, const bool invert) const

label	countKeys (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of keys that satisfy the unary predicate. More...

Foam::label	countKeys (const UnaryPredicate &pred, const bool invert) const

label	countValues (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of values that satisfy the unary predicate. More...

Foam::label	countValues (const UnaryPredicate &pred, const bool invert) const

label	countEntries (const BinaryPredicate &pred, const bool invert=false) const
	Count the number of entries that satisfy the binary predicate. More...

Foam::label	countEntries (const BinaryPredicate &pred, const bool invert) const

bool	emplace (const word &key, Args &&... args)
	Emplace insert a new entry, not overwriting existing entries. More...

bool	emplace_set (const word &key, Args &&... args)
	Emplace set an entry, overwriting any existing entries. More...

bool	insert (const word &key, const regIOobject * &obj)
	Copy insert a new entry, not overwriting existing entries. More...

bool	insert (const word &key, regIOobject * &&obj)
	Move insert a new entry, not overwriting existing entries. More...

bool	set (const word &key, const regIOobject * &obj)
	Copy assign a new entry, overwriting existing entries. More...

bool	set (const word &key, regIOobject * &&obj)
	Move assign a new entry, overwriting existing entries. More...

bool	erase (const iterator &iter)
	Erase an entry specified by given iterator. More...

bool	erase (const word &key)
	Erase an entry specified by the given key. More...

label	erase (const HashTable< AnyType, word, AnyHash > &other)
	Remove table entries given by keys of the other hash-table. More...

label	erase (std::initializer_list< word > keys)
	Remove table entries given by the listed keys. More...

label	erase (InputIter first, InputIter last)
	Remove multiple entries using an iterator range of keys. More...

label	erase (const FixedList< word, N > &keys)
	Remove table entries given by the listed keys. More...

label	erase (const UList< word > &keys)
	Remove table entries given by the listed keys. More...

Foam::label	erase (InputIter first, InputIter last)

Foam::label	erase (const FixedList< word, N > &keys)

Foam::label	erase (const HashTable< AnyType, word, AnyHash > &other)

label	retain (const HashTable< AnyType, word, AnyHash > &other)
	Retain table entries given by keys of the other hash-table. More...

Foam::label	retain (const HashTable< AnyType, word, AnyHash > &other)

label	filterKeys (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their keys. More...

Foam::label	filterKeys (const UnaryPredicate &pred, const bool pruning)

label	filterValues (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their values. More...

Foam::label	filterValues (const UnaryPredicate &pred, const bool pruning)

label	filterEntries (const BinaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their key/value. More...

Foam::label	filterEntries (const BinaryPredicate &pred, const bool pruning)

void	resize (const label sz)
	Resize the hash table for efficiency. More...

void	clear ()
	Clear all entries from table. More...

void	clearStorage ()
	Clear the table entries and the table itself. More...

void	swap (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs)
	Swap contents into this table. More...

void	transfer (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs)
	Transfer contents into this table. More...

regIOobject * &	operator[] (const word &key)
	Find and return a hashed entry. FatalError if it does not exist. More...

const regIOobject * &	operator[] (const word &key) const
	Find and return a hashed entry. FatalError if it does not exist. More...

regIOobject * &	operator() (const word &key)
	Return existing entry or create a new entry. More...

regIOobject * &	operator() (const word &key, const regIOobject * &deflt)
	Return existing entry or insert a new entry. More...

void	operator= (const this_type &rhs)
	Copy assign. More...

void	operator= (std::initializer_list< std::pair< word, regIOobject * >> rhs)
	Copy assign from an initializer list. More...

void	operator= (this_type &&rhs)
	Move assign. More...

bool	operator== (const this_type &rhs) const

bool	operator!= (const this_type &rhs) const
	The opposite of the equality operation. More...

this_type &	operator+= (const this_type &rhs)
	Add entries into this HashTable. More...

const_iterator_pair< const_key_iterator, this_type >	keys () const
	A const iterator begin/end pair for iterating over keys. More...

iterator	begin ()
	iterator set to the beginning of the HashTable More...

const_iterator	begin () const
	const_iterator set to the beginning of the HashTable More...

const_iterator	cbegin () const
	const_iterator set to the beginning of the HashTable More...

iterator	end () noexcept
	iterator to signal the end (for any HashTable) More...

const_iterator	end () const noexcept
	const_iterator to signal the end (for any HashTable) More...

constexpr const_iterator	cend () const noexcept
	const_iterator to signal the end (for any HashTable) More...

Ostream &	printInfo (Ostream &os) const
	Print information. More...

Ostream &	writeKeys (Ostream &os, const label shortLen=0) const

Public Member Functions inherited from PrimitivePatch<::Foam::List< face >, pointField >
	PrimitivePatch (const ::Foam::List< face > &faces, const pointField &points)
	Construct from components. More...

	PrimitivePatch (::Foam::List< face > &&faces, const pointField &points)
	Construct from components, transferring faces. More...

	PrimitivePatch (::Foam::List< face > &faces, pointField &points, const bool reuse)
	Construct from components, reuse storage. More...

	PrimitivePatch (const PrimitivePatch< ::Foam::List< face >, pointField > &pp)
	Copy construct. More...

virtual	~PrimitivePatch ()
	Destructor. More...

void	clearOut ()

void	clearGeom ()

void	clearTopology ()

void	clearPatchMeshAddr ()

void	swap (PrimitivePatch &)=delete
	Suppress direct swapping, since storage containers may be const. More...

const Field< point_type > &	points () const noexcept
	Return reference to global points. More...

label	nFaces () const noexcept
	Number of faces in the patch. More...

label	nPoints () const
	Number of points supporting patch faces. More...

label	nEdges () const
	Number of edges in patch. More...

const edgeList &	edges () const
	Return list of edges, address into LOCAL point list. More...

const edgeList::subList	internalEdges () const
	Return sub-list of internal edges, address into LOCAL point list. More...

const edgeList::subList	boundaryEdges () const
	Return sub-list of boundary edges, address into LOCAL point list. More...

label	nInternalEdges () const
	Number of internal edges. More...

label	nBoundaryEdges () const
	Number of boundary edges == (nEdges() - nInternalEdges()) More...

bool	isInternalEdge (const label edgei) const
	Is internal edge? More...

const labelList &	boundaryPoints () const
	Return list of boundary points, address into LOCAL point list. More...

const labelListList &	faceFaces () const
	Return face-face addressing. More...

const labelListList &	edgeFaces () const
	Return edge-face addressing. More...

const labelListList &	faceEdges () const
	Return face-edge addressing. More...

const labelListList &	pointEdges () const
	Return point-edge addressing. More...

const labelListList &	pointFaces () const
	Return point-face addressing. More...

const List< face_type > &	localFaces () const
	Return patch faces addressing into local point list. More...

labelList	boundaryFaces () const

labelList	uniqBoundaryFaces () const

const labelList &	meshPoints () const
	Return labelList of mesh points in patch. More...

const Map< label > &	meshPointMap () const
	Mesh point map. More...

const Field< point_type > &	localPoints () const
	Return pointField of points in patch. More...

const labelList &	localPointOrder () const
	Return orders the local points for most efficient search. More...

label	whichPoint (const label gp) const
	Given a global point index, return the local point index. More...

edge	meshEdge (const label edgei) const
	From patch edge to global edge using meshPoints. More...

edge	meshEdge (const edge &e) const
	From patch edge to global edge using meshPoints. More...

label	meshEdge (const label edgei, const edgeList &allEdges, const labelListList &pointEdges) const

label	findEdge (const edge &e) const

labelList	meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const

labelList	meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const

labelList	meshEdges (const labelUList &edgeLabels, const edgeList &allEdges, const labelListList &pointEdges) const

const Field< point_type > &	faceCentres () const
	Return face centres for patch. More...

const Field< point_type > &	faceAreas () const
	Return face area vectors for patch. More...

const Field< scalar > &	magFaceAreas () const
	Return face area magnitudes for patch. More...

const Field< point_type > &	faceNormals () const
	Return face unit normals for patch. More...

const Field< point_type > &	pointNormals () const
	Return point normals for patch. More...

bool	hasFaceAreas () const

bool	hasFaceCentres () const

bool	hasFaceNormals () const

bool	hasPointNormals () const

bool	hasBoundaryPoints () const

bool	hasFaceFaces () const

bool	hasEdgeFaces () const

bool	hasFaceEdges () const

bool	hasPointEdges () const

bool	hasPointFaces () const

bool	hasMeshPointMap () const

List< objectHit >	projectPoints (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
	Project vertices of patch onto another patch. More...

Foam::List< Foam::objectHit >	projectPoints (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< ::Foam::List< face >, pointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const

List< objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const
	Project vertices of patch onto another patch. More...

Foam::List< Foam::objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< ::Foam::List< face >, pointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const

const labelListList &	edgeLoops () const
	Return list of closed loops of boundary vertices. More...

surfaceTopo	surfaceType () const
	Calculate surface type formed by patch. More...

bool	checkTopology (const bool report=false, labelHashSet *setPtr=nullptr) const
	Check surface formed by patch for manifoldness (see above). More...

bool	checkPointManifold (const bool report=false, labelHashSet *setPtr=nullptr) const
	Checks primitivePatch for faces sharing point but not edge. More...

virtual void	movePoints (const Field< point_type > &)
	Correct patch after moving points. More...

void	operator= (const PrimitivePatch< ::Foam::List< face >, pointField > &rhs)
	Copy assign faces. Leave points alone (could be a reference). More...

void	operator= (PrimitivePatch< ::Foam::List< face >, pointField > &&rhs)
	Move assign faces. Leave points alone (could be a reference). More...

label	whichEdge (const edge &e) const
	Identical to findEdge. More...

Public Member Functions inherited from PrimitivePatchBase
	ClassName ("PrimitivePatch")
	Runtime type information. More...

	PrimitivePatchBase ()=default
	Default construct. More...

Public Member Functions inherited from List< face >
constexpr	List () noexcept
	Default construct. More...

	List (const label len)
	Construct with given size. More...

	List (const label len, const face &val)
	Construct with given size and value for all elements. More...

	List (const label len, const Foam::zero)
	Construct with given size initializing all elements to zero. More...

	List (const Foam::one, const face &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, face &&val)
	Construct with length=1, moving the value as the only content. More...

	List (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...

	List (const List< face > &a)
	Copy construct from list. More...

	List (const UList< face > &a)
	Copy construct contents from list. More...

	List (List< face > &a, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< face > &list, const labelUList &indices)
	Copy construct subset of list. More...

	List (const UList< face > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...

	List (const FixedList< face, N > &list)
	Construct as copy of FixedList<T, N> More...

	List (const PtrList< face > &list)
	Construct as copy of PtrList<T> More...

	List (const SLList< face > &list)
	Construct as copy of SLList<T> More...

	List (const IndirectListBase< face, Addr > &list)
	Construct as copy of IndirectList contents. More...

	List (std::initializer_list< face > list)
	Construct from an initializer list. More...

	List (List< face > &&list)
	Move construct from List. More...

	List (DynamicList< face, SizeMin > &&list)
	Move construct from DynamicList. More...

	List (SortableList< face > &&list)
	Move construct from SortableList. More...

	List (SLList< face > &&list)
	Move construct from SLList. More...

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

autoPtr< List< face > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	resize (const label len)
	Adjust allocated size of list. More...

void	resize (const label len, const face &val)
	Adjust allocated size of list and set val for new elements. More...

void	resize (const label newLen)

void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily. More...

void	setSize (const label n)
	Alias for resize() More...

void	setSize (const label n, const face &val)
	Alias for resize() More...

void	append (const face &val)
	Append an element at the end of the list. More...

void	append (face &&val)
	Move append an element at the end of the list. More...

void	append (const UList< face > &list)
	Append a List to the end of this list. More...

void	append (const IndirectListBase< face, Addr > &list)
	Append IndirectList contents at the end of this list. More...

label	appendUniq (const face &val)
	Append an element if not already in the list. More...

void	transfer (List< face > &list)

void	transfer (DynamicList< face, SizeMin > &list)

void	transfer (SortableList< face > &list)

face &	newElmt (const label i)

void	operator= (const UList< face > &a)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< face > &list)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< face > &list)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const IndirectListBase< face, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

void	operator= (const FixedList< face, N > &list)
	Copy assignment from FixedList. More...

void	operator= (std::initializer_list< face > list)
	Assignment to an initializer list. More...

void	operator= (const face &val)
	Assignment of all entries to the given value. More...

void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...

void	operator= (List< face > &&list)
	Move assignment. Takes constant time. More...

void	operator= (DynamicList< face, SizeMin > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SortableList< face > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< face > &&list)
	Move assignment. Takes constant time. More...

Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List. More...

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

void	shallowCopy (const UList< face > &)=delete
	No shallowCopy permitted. More...

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool. More...

Public Member Functions inherited from meshedSurf
constexpr	meshedSurf () noexcept=default
	Default construct. More...

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

virtual const labelList &	faceIds () const
	Per-face identifier (eg, element Id) More...

Static Public Attributes
static const word	pointDataName
	Name for point fields sub-registry. More...

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 float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...

static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...

Protected Member Functions
pointField &	storedPoints ()
	Non-const access to points. More...

faceList &	storedFaces ()
	Non-const access to the faces. More...

const faceList &	storedFaces () const
	Const access to the faces. More...

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

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

Protected Member Functions inherited from HashTable< regIOobject * >
bool	iterator_erase (node_type *&entry, label &index)
	Low-level entry erasure using iterator internals. More...

Additional Inherited Members
Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...

static bool	bannerEnabled (bool on) noexcept
	Enable/disable an output file banner. More...

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

static word	scopedName (const std::string &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, const bool noSyntaxHint=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 List< face >
static const List< face > &	null ()
	Return a null List. More...

Public Attributes inherited from HashTable< regIOobject * >
const typedef regIOobject * *	const_pointer
	Const pointer type for the stored value_type. More...

const typedef regIOobject * &	const_reference
	Const reference to the stored value_type. More...

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
	To flag master-only reading of objects. More...

Detailed Description

A surface mesh consisting of general polygon faces and capable of holding fields.

Source files

Definition at line 67 of file polySurface.H.

Member Typedef Documentation

◆ Mesh

typedef polySurface Mesh

Typedef required for GeoMesh.

Definition at line 144 of file polySurface.H.

◆ BoundaryMesh

typedef bool BoundaryMesh

Placeholder only, for GeoMesh.

Definition at line 147 of file polySurface.H.

Member Enumeration Documentation

◆ FieldAssociation

enum FieldAssociation

Enumeration for the field association.

Enumerator
NO_DATA	No associated data.
FACE_DATA	Data associated with faces.
POINT_DATA	Data associated with points.
FACE_OR_POINT_DATA	Data associated with faces or points.

Definition at line 76 of file polySurface.H.

Constructor & Destructor Documentation

◆ polySurface() [1/4]

polySurface	(	const IOobject &	io,
		bool	doCheckIn = `false`
	)

explicit

Construct null with NO_READ, NO_WRITE optionally with a checkIn on the parent registry.

Created without a PointData sub-registry

Definition at line 85 of file polySurface.C.

References regIOobject::store().

Here is the call graph for this function:

◆ polySurface() [2/4]

polySurface	(	const word &	surfName,
		const objectRegistry &	obr,
		bool	doCheckIn = `false`
	)

Construct null with specified name on the given registry, optionally with a checkIn on the parent registry.

Created without a PointData sub-registry

Definition at line 112 of file polySurface.C.

◆ polySurface() [3/4]

polySurface	(	const IOobject &	io,
		const MeshedSurface< face > &	surf,
		bool	doCheckIn = `false`
	)

Copy construct from MeshedSurface<face> contents with NO_READ, NO_WRITE optionally with a checkIn on the parent registry.

Created without a PointData sub-registry

Definition at line 135 of file polySurface.C.

◆ polySurface() [4/4]

polySurface	(	const IOobject &	io,
		MeshedSurface< face > &&	surf,
		bool	doCheckIn = `false`
	)

Move construct from MeshedSurface<face> contents with NO_READ, NO_WRITE optionally with a checkIn on the parent registry.

Created without a PointData sub-registry

Definition at line 148 of file polySurface.C.

◆ ~polySurface()

~polySurface ( )

virtual

Destructor.

clearOut(); // Clear addressing

Definition at line 162 of file polySurface.C.

Member Function Documentation

◆ storedPoints()

pointField& storedPoints ( )

inlineprotected

Non-const access to points.

Definition at line 117 of file polySurface.H.

References PrimitivePatch<::Foam::List< face >, pointField >::points().

Here is the call graph for this function:

◆ storedFaces() [1/2]

faceList& storedFaces ( )

inlineprotected

Non-const access to the faces.

Definition at line 123 of file polySurface.H.

Referenced by polySurface::faces().

Here is the caller graph for this function:

◆ storedFaces() [2/2]

const faceList& storedFaces ( ) const

inlineprotected

Const access to the faces.

Definition at line 129 of file polySurface.H.

◆ TypeName()

TypeName ( "polySurface" )

Runtime type information.

◆ nPoints()

virtual label nPoints ( ) const

inlinevirtual

Return the number of points.

Definition at line 214 of file polySurface.H.

References PrimitivePatch<::Foam::List< face >, pointField >::points().

Here is the call graph for this function:

◆ nFaces()

virtual label nFaces ( ) const

inlinevirtual

Return the number of faces.

Definition at line 220 of file polySurface.H.

◆ size()

virtual label size ( ) const

inlinevirtual

Return number of faces.

Definition at line 226 of file polySurface.H.

◆ points()

virtual const pointField& points ( ) const

inlinevirtual

Return points.

Implements meshedSurf.

Definition at line 233 of file polySurface.H.

References PrimitivePatch<::Foam::List< face >, pointField >::points().

Here is the call graph for this function:

◆ faces()

virtual const faceList& faces ( ) const

inlinevirtual

Return faces.

Implements meshedSurf.

Definition at line 239 of file polySurface.H.

References polySurface::storedFaces().

Here is the call graph for this function:

◆ zoneIds()

virtual const labelList& zoneIds ( ) const

inlinevirtual

Const access to per-face zone/region information (demand-driven)

Reimplemented from meshedSurf.

Definition at line 245 of file polySurface.H.

◆ Sf()

const vectorField& Sf ( ) const

inline

Return face area vectors (normals)

Definition at line 251 of file polySurface.H.

References PrimitivePatch<::Foam::List< face >, pointField >::faceAreas().

Here is the call graph for this function:

◆ magSf()

const scalarField& magSf ( ) const

inline

Return face area magnitudes.

Definition at line 257 of file polySurface.H.

References PrimitivePatch<::Foam::List< face >, pointField >::magFaceAreas().

Here is the call graph for this function:

◆ Cf()

const vectorField& Cf ( ) const

inline

Face centres.

Definition at line 263 of file polySurface.H.

References PrimitivePatch<::Foam::List< face >, pointField >::faceCentres().

Here is the call graph for this function:

◆ copySurface() [1/3]

void copySurface	(	const pointField &	points,
		const faceList &	faces,
		bool	unused = `false`
	)

Update with new contents.

Definition at line 280 of file polySurface.C.

References List< T >::clear(), nPoints, and points.

Referenced by sampledSurface::storeRegistrySurface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copySurface() [2/3]

void copySurface	(	const meshedSurf &	surf,
		bool	unused = `false`
	)

Update with new contents.

Definition at line 311 of file polySurface.C.

References meshedSurf::faces(), nPoints, meshedSurf::points(), and meshedSurf::zoneIds().

Here is the call graph for this function:

◆ copySurface() [3/3]

void copySurface	(	const MeshedSurface< face > &	surf,
		bool	unused = `false`
	)

Update with new contents.

Definition at line 341 of file polySurface.C.

References nPoints, MeshedSurface< Face >::size(), MeshedSurface< Face >::surfFaces(), and MeshedSurface< Face >::surfZones().

Here is the call graph for this function:

◆ transfer() [1/2]

void transfer	(	pointField &&	points,
		faceList &&	faces,
		labelList &&	zoneIds = `labelList()`
	)

Transfer the contents of the argument and annul the argument.

Optionally validate the zone coverage.

Definition at line 371 of file polySurface.C.

References points.

Referenced by areaWrite::write().

Here is the caller graph for this function:

◆ transfer() [2/2]

void transfer	(	MeshedSurface< face > &	surf,
		bool	validate = `false`
	)

Transfer the contents of the argument and annul the argument.

Optionally validate the zone coverage.

Definition at line 387 of file polySurface.C.

References MeshedSurface< Face >::storedFaces(), MeshedSurface< Face >::storedPoints(), and MeshedSurface< Face >::surfZones().

Here is the call graph for this function:

◆ nFaceData()

Foam::label nFaceData ( ) const

Number of main entries, without PointData sub-registry.

Definition at line 170 of file polySurface.C.

References Foam::BitOps::count(), and HashTable< regIOobject * >::size().

Here is the call graph for this function:

◆ nPointData()

Foam::label nPointData ( ) const

Number of entries on PointData sub-registry (if it exists)

Definition at line 184 of file polySurface.C.

References HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

◆ queryFieldAssociation()

Foam::polySurface::FieldAssociation queryFieldAssociation ( const word & fieldName ) const

Query the field association (FACE or POINT)

Definition at line 212 of file polySurface.C.

References Foam::expressions::FACE_DATA, objectRegistry::found(), Foam::expressions::NO_DATA, and Foam::expressions::POINT_DATA.

Here is the call graph for this function:

◆ findFieldObject() [1/7]

const Foam::regIOobject * findFieldObject	(	const word &	fieldName,
		const FieldAssociation	association
	)		const

Find the field object with the given name and required FieldAssociation (FACE or POINT).

For FACE_POINT_DATA, face data are checked first.

Returns: nullptr is the field was not found

Definition at line 242 of file polySurface.C.

References objectRegistry::cfindObject(), Foam::expressions::FACE_DATA, and Foam::expressions::POINT_DATA.

Here is the call graph for this function:

◆ findFieldObject() [2/7]

const regIOobject* findFieldObject ( const word & fieldName ) const

General finding of the field object (FACE or POINT)

Later specializations are used to restrict the scope.

Returns: nullptr is the field was not found

◆ whichRegistry() [1/6]

const objectRegistry* whichRegistry ( const word & fieldName ) const

General finding of the registry with the field object (FACE or POINT).

Later specializations are used to restrict the scope.

Returns: nullptr is the field was not found

◆ fieldData() [1/2]

const objectRegistry& fieldData ( ) const

inline

Regular data are stored directly on the registry.

Definition at line 347 of file polySurface.H.

◆ faceData()

const Foam::objectRegistry & faceData ( ) const

Face data are stored directly on the registry.

Definition at line 198 of file polySurface.C.

◆ pointData()

const Foam::objectRegistry & pointData ( ) const

Point data are stored in a sub-registry.

Note that this method with automatically create the corresponding sub-registry if it did not previously exist. Use the nPointData() methods instead if you wish to test for content without this side-effect.

Definition at line 204 of file polySurface.C.

References objectRegistry::subRegistry().

Referenced by polySurface::fieldData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeField() [1/2]

void storeField	(	const word &	fieldName,
		const dimensionSet &	dims,
		const Field< Type > &	values
	)

Copy/store named field as face or point data (template parameter).

Default is face-data (polySurfaceGeoMesh as template). For point data use (polySurfacePointGeoMesh as template).

Definition at line 96 of file polySurfaceTemplates.C.

References DimensionedField< Type, GeoMesh >::dimensions(), objectRegistry::getObjectPtr(), and Foam::HashTableOps::values().

Referenced by sampledSurface::storeRegistryField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeField() [2/2]

void storeField	(	const word &	fieldName,
		const dimensionSet &	dims,
		Field< Type > &&	values
	)

Move/store named field as face or point data (template parameter).

Default is face-data (polySurfaceGeoMesh as template). For point data use (polySurfacePointGeoMesh as template).

Definition at line 137 of file polySurfaceTemplates.C.

References DimensionedField< Type, GeoMesh >::dimensions(), objectRegistry::getObjectPtr(), and Foam::HashTableOps::values().

Here is the call graph for this function:

◆ writeObject()

bool writeObject	(	IOstreamOption	streamOpt,
		const bool	valid
	)		const

virtual

Write - this is a no-op.

Reimplemented from objectRegistry.

Definition at line 33 of file polySurfaceIO.C.

◆ clearGeom()

void clearGeom ( )

Clear geometry.

Definition at line 33 of file polySurfaceClear.C.

References PrimitivePatch<::Foam::List< face >, pointField >::clearGeom(), DebugInFunction, and Foam::endl().

Here is the call graph for this function:

◆ clearAddressing()

void clearAddressing ( )

Clear addressing.

Definition at line 41 of file polySurfaceClear.C.

References DebugInFunction, and Foam::endl().

Here is the call graph for this function:

◆ clearOut()

void clearOut ( )

Clear all geometry and addressing unnecessary for CFD.

Definition at line 49 of file polySurfaceClear.C.

◆ clearPrimitives()

void clearPrimitives ( )

Clear primitive data (points, faces and cells)

◆ clearFields()

void clearFields ( )

Clear stored fields.

Definition at line 58 of file polySurfaceClear.C.

References objectRegistry::clear().

Here is the call graph for this function:

◆ findFieldObject() [3/7]

const regIOobject* findFieldObject ( const word & fieldName ) const

Definition at line 452 of file polySurface.C.

◆ findFieldObject() [4/7]

const regIOobject* findFieldObject ( const word & fieldName ) const

Definition at line 463 of file polySurface.C.

References objectRegistry::cfindObject().

Here is the call graph for this function:

◆ whichRegistry() [2/6]

const objectRegistry* whichRegistry ( const word & fieldName ) const

Definition at line 484 of file polySurface.C.

References objectRegistry::found().

Here is the call graph for this function:

◆ whichRegistry() [3/6]

const objectRegistry* whichRegistry ( const word & fieldName ) const

Definition at line 502 of file polySurface.C.

References objectRegistry::found().

Here is the call graph for this function:

◆ findFieldObject() [5/7]

const regIOobject* findFieldObject ( const word & fieldName ) const

Find face field object (on main registry).

◆ findFieldObject() [6/7]

const regIOobject* findFieldObject ( const word & fieldName ) const

Find point field object (on sub-registry)

◆ whichRegistry() [4/6]

const objectRegistry* whichRegistry ( const word & fieldName ) const

Return field object (on main registry). Face data field found on main registry?

◆ whichRegistry() [5/6]

const objectRegistry* whichRegistry ( const word & fieldName ) const

Point data field found on sub-registry?

◆ fieldData() [2/2]

const objectRegistry& fieldData ( ) const

inline

Point data are stored in a sub-registry.

Definition at line 453 of file polySurface.H.

References polySurface::pointData().

Here is the call graph for this function:

◆ findFieldObject() [7/7]

const Foam::regIOobject* findFieldObject ( const word & fieldName ) const

Definition at line 36 of file polySurfaceTemplates.C.

References objectRegistry::cfindObject(), and forAllConstIters().

Here is the call graph for this function:

◆ whichRegistry() [6/6]

const Foam::objectRegistry* whichRegistry ( const word & fieldName ) const

Definition at line 67 of file polySurfaceTemplates.C.

References forAllConstIters(), and objectRegistry::found().

Here is the call graph for this function:

Member Data Documentation

◆ pointDataName

const Foam::word pointDataName

static

Name for point fields sub-registry.

Definition at line 150 of file polySurface.H.

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

src/surfMesh/polySurface/polySurface.H
src/surfMesh/polySurface/polySurface.C
src/surfMesh/polySurface/polySurfaceClear.C
src/surfMesh/polySurface/polySurfaceIO.C
src/surfMesh/polySurface/polySurfaceTemplates.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Mesh

◆ BoundaryMesh

Member Enumeration Documentation

◆ FieldAssociation

Constructor & Destructor Documentation

◆ polySurface() [1/4]

◆ polySurface() [2/4]

◆ polySurface() [3/4]

◆ polySurface() [4/4]

◆ ~polySurface()

Member Function Documentation

◆ storedPoints()

◆ storedFaces() [1/2]

◆ storedFaces() [2/2]

◆ TypeName()

◆ nPoints()

◆ nFaces()

◆ size()

◆ points()

◆ faces()

◆ zoneIds()

◆ Sf()

◆ magSf()

◆ Cf()

◆ copySurface() [1/3]

◆ copySurface() [2/3]

◆ copySurface() [3/3]

◆ transfer() [1/2]

◆ transfer() [2/2]

◆ nFaceData()

◆ nPointData()

◆ queryFieldAssociation()

◆ findFieldObject() [1/7]

◆ findFieldObject() [2/7]

◆ whichRegistry() [1/6]

◆ fieldData() [1/2]

◆ faceData()

◆ pointData()

◆ storeField() [1/2]

◆ storeField() [2/2]

◆ writeObject()

◆ clearGeom()

◆ clearAddressing()

◆ clearOut()

◆ clearPrimitives()

◆ clearFields()

◆ findFieldObject() [3/7]

◆ findFieldObject() [4/7]

◆ whichRegistry() [2/6]

◆ whichRegistry() [3/6]

◆ findFieldObject() [5/7]

◆ findFieldObject() [6/7]

◆ whichRegistry() [4/6]

◆ whichRegistry() [5/6]

◆ fieldData() [2/2]

◆ findFieldObject() [7/7]

◆ whichRegistry() [6/6]

Member Data Documentation

◆ pointDataName