A surface mesh consisting of general polygon faces. More...

Inheritance diagram for surfMesh:

[legend]

Collaboration diagram for surfMesh:

[legend]

Public Types
enum	readUpdateState { UNCHANGED, POINTS_MOVED, TOPO_CHANGE, TOPO_PATCH_CHANGE }
	Enumeration defining the state of the mesh after a read update. More...

typedef surfMesh	Mesh

typedef bool	BoundaryMesh
	Placeholder only, but do not remove - it is needed for GeoMesh. More...

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

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

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

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

Public Types inherited from HashTable< regIOobject * >
typedef T	value_type
	Type of values the HashTable contains. More...

typedef T &	reference
	Type that can be used for storing into HashTable::value_type. More...

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

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

enum	surfaceTopo
	Enumeration defining the surface type. Used in check routines. More...

typedef face	FaceType

typedef face	FaceType

typedef ::Foam::UList< face >	FaceListType

typedef ::Foam::UList< face >	FaceListType

typedef ::Foam::SubField< point >	PointFieldType

typedef ::Foam::SubField< point >	PointFieldType

Public Types inherited from UList< face >
typedef T	value_type
	Type of values the UList contains. More...

typedef T &	reference
	Type that can be used for storing into. More...

typedef label	difference_type
	The type that can represent the difference between any two. More...

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

typedef T *	iterator
	Random access iterator for traversing UList. More...

typedef T *	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

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

	surfMesh (const IOobject &, const word &surfName="")
	Construct from IOobject, with alternative surface name. More...

	surfMesh (const IOobject &, const Xfer< pointField > &, const Xfer< faceList > &, const word &surfName="")
	Construct by transferring components (points, faces) without zones. More...

	surfMesh (const IOobject &, const Xfer< MeshedSurface< face > > &surf, const word &surfName="")
	Construct copy/move from MeshedSurface. More...

virtual	~surfMesh ()
	Destructor. More...

fileName	meshDir () const
	Return the local mesh directory (dbDir()/meshSubDir) 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...

void	setInstance (const fileName &)
	Set the instance for mesh files. More...

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

virtual label	nFaces () const
	Return the number of raw 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 surfZoneList &	surfZones () const
	Return surface zones. More...

void	checkZones ()
	Check the surface zone definitions. More...

void	addZones (const List< surfZone > &, const bool validate=true)
	Add surface zones. More...

virtual readUpdateState	readUpdate ()
	Update the mesh based on the mesh files saved in. More...

void	removeZones ()
	Update the mesh corresponding to given map. More...

void	resetPrimitives (const Xfer< pointField > &points, const Xfer< faceList > &faces, const Xfer< surfZoneList > &zones, const bool validate=true)
	Reset mesh primitive data. More...

void	transfer (MeshedSurface< face > &)
	Transfer the contents of the argument and annul the argument. More...

void	write (const fileName &)
	Write to file. More...

Xfer< MeshedSurface< face > >	xfer ()
	Transfer contents to the Xfer container as a MeshedSurface. 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	removeFiles (const fileName &instanceDir) const
	Remove all files from mesh instance. More...

void	removeFiles () const
	Remove all files from mesh instance() More...

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

	surfaceRegistry (const objectRegistry &, const word &surfName="")
	Construct for the given objectRegistry and named surface. More...

virtual	~surfaceRegistry ()
	Destructor. More...

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

	objectRegistry (const Time &db, const label nIoObjects=128)
	Construct the time objectRegistry given an initial estimate. More...

	objectRegistry (const IOobject &io, const label nIoObjects=128)
	Construct a sub-registry given an IObject to describe the registry. More...

virtual	~objectRegistry ()
	Destructor. More...

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

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

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

wordList	names () const
	Return the list of names of the IOobjects. More...

wordList	sortedNames () const
	Return the sorted list of names of the IOobjects. More...

wordList	names (const word &className) const
	Return the list of names of IOobjects of given class name. More...

wordList	sortedNames (const word &className) const
	Return the sorted list of names of IOobjects of given class name. More...

template<class Type >
wordList	names () const
	Return the list of names of the IOobjects of given type. More...

template<class Type >
wordList	names (const wordRe &name) const
	Return the list of objects whose name matches the input regExp. More...

template<class Type >
wordList	names (const wordReList &name) const
	Return the list of objects whose name matches the input regExp. More...

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

template<class Type >
HashTable< const Type * >	lookupClass (const bool strict=false) const
	Lookup and return all objects of the given Type. More...

template<class Type >
HashTable< Type * >	lookupClass (const bool strict=false)
	Lookup and return all objects of the given Type. More...

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

template<class Type >
const Type &	lookupObject (const word &name) const
	Lookup and return the object of the given Type. More...

template<class Type >
Type &	lookupObjectRef (const word &name) const

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

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

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

bool	checkOut (regIOobject &) const
	Remove an regIOobject from registry. 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...

virtual bool	writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const
	Write the objects. More...

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

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

template<class Type >
Foam::wordList	names (const wordReList &patterns) 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 &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

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

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

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

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

virtual	~regIOobject ()
	Destructor. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

void	close ()
	Close Istream. More...

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

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

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

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

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

void	operator= (const IOobject &)

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

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

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

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

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

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

virtual	~IOobject ()
	Destructor. More...

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

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

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

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

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

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

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

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

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

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

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

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

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

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

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

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

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

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

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

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

bool	good () const

bool	bad () const

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

void	operator= (const IOobject &)

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

Public Member Functions inherited from HashTable< regIOobject * >
bool	set (const Key &, const T &newElmt)
	Assign a new hashedEntry, overwriting existing entries. More...

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

	HashTable (Istream &, const label size=128)
	Construct from Istream. More...

	HashTable (const HashTable< T, Key, Hash > &)
	Construct as copy. More...

	HashTable (const Xfer< HashTable< T, Key, Hash > > &)
	Construct by transferring the parameter contents. More...

	~HashTable ()
	Destructor. More...

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

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

bool	empty () const
	Return true if the hash table is empty. More...

bool	found (const Key &) const
	Return true if hashedEntry is found in table. More...

iterator	find (const Key &)
	Find and return an iterator set at the hashedEntry. More...

const_iterator	find (const Key &) const
	Find and return an const_iterator set at the hashedEntry. More...

List< Key >	toc () const
	Return the table of contents. More...

List< Key >	sortedToc () const
	Return the table of contents as a sorted list. More...

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

bool	insert (const Key &, const T &newElmt)
	Insert a new hashedEntry. More...

bool	erase (const iterator &)
	Erase a hashedEntry specified by given iterator. More...

bool	erase (const Key &)
	Erase a hashedEntry specified by the given key. More...

label	erase (const UList< Key > &)
	Remove entries given by the listed keys from this HashTable. More...

label	erase (const HashTable< AnyType, Key, AnyHash > &)
	Remove entries given by the given keys from this HashTable. More...

Foam::label	erase (const HashTable< AnyType, Key, AnyHash > &rhs)

void	resize (const label newSize)
	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	shrink ()
	Shrink the allocated table to approx. twice number of elements. More...

void	transfer (HashTable< T, Key, Hash > &)
	Transfer the contents of the argument table into this table. More...

Xfer< HashTable< T, Key, Hash > >	xfer ()
	Transfer contents to the Xfer container. More...

T &	operator[] (const Key &)
	Find and return a hashedEntry. More...

const T &	operator[] (const Key &) const
	Find and return a hashedEntry. More...

T &	operator() (const Key &)
	Find and return a hashedEntry, create it null if not present. More...

void	operator= (const HashTable< T, Key, Hash > &)
	Assignment. More...

bool	operator== (const HashTable< T, Key, Hash > &) const
	Equality. Hash tables are equal if the keys and values are equal. More...

bool	operator!= (const HashTable< T, Key, Hash > &) const
	The opposite of the equality operation. Takes linear time. 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...

Public Member Functions inherited from PrimitivePatch< face, ::Foam::UList, ::Foam::SubField< point >, point >
	PrimitivePatch (const ::Foam::UList< face > &faces, const Field< point > &points)
	Construct from components. More...

	PrimitivePatch (::Foam::UList< face > &faces, Field< point > &points, const bool reUse)
	Construct from components, reuse storage. More...

	PrimitivePatch (const PrimitivePatch< face, ::Foam::UList, ::Foam::SubField< point >, point > &)
	Construct as copy. More...

	PrimitivePatch (const ::Foam::UList< face > &faces, const Field< point > &points)
	Construct from components. More...

	PrimitivePatch (const Xfer< ::Foam::UList< face > > &faces, const Xfer< List< point > > &points)
	Construct from components. More...

	PrimitivePatch (::Foam::UList< face > &faces, Field< point > &points, const bool reUse)
	Construct from components, reuse storage. More...

	PrimitivePatch (const PrimitivePatch< face, ::Foam::UList, ::Foam::SubField< point >, point > &)
	Construct as copy. More...

virtual	~PrimitivePatch ()

virtual	~PrimitivePatch ()
	Destructor. More...

void	clearOut ()

void	clearOut ()

void	clearGeom ()

void	clearGeom ()

void	clearTopology ()

void	clearTopology ()

void	clearPatchMeshAddr ()

void	clearPatchMeshAddr ()

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

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

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

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

label	nEdges () const
	Return number of edges in patch. More...

label	nEdges () const
	Return number of edges in patch. More...

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

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

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

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

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

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

const labelList &	boundaryPoints () const
	Return list of boundary points,. More...

const labelList &	boundaryPoints () const
	Return list of boundary points,. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

const Map< label > &	meshPointMap () const
	Mesh point map. Given the global point index find its. More...

const Map< label > &	meshPointMap () const
	Mesh point map. Given the global point index find its. More...

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

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

const labelList &	localPointOrder () const
	Return orders the local points for most efficient search. 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. More...

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

label	whichEdge (const edge &e) const
	Given an edge in local point labels, return its index. More...

label	whichEdge (const edge &) const
	Given an edge in local point labels, return its. More...

labelList	meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
	Return labels of patch edges in the global edge list using. More...

labelList	meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
	Return labels of patch edges in the global edge list using. More...

labelList	meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const
	Return labels of patch edges in the global edge list using. More...

labelList	meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const
	Return labels of patch edges in the global edge list using. More...

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

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

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

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

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

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

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

List< objectHit >	projectPoints (const ToPatch &targetPatch, const Field< point > &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< point > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const

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

List< objectHit >	projectFaceCentres (const ToPatch &targetPatch, const Field< point > &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< point > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const

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

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

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

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

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

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

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

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

void	writeVTK (const fileName &name) const
	Write VTK patch. More...

void	writeVTKNormals (const fileName &name) const
	Write VTK patch normals. More...

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

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

void	operator= (const PrimitivePatch< face, ::Foam::UList, ::Foam::SubField< point >, point > &)
	Assignment. More...

void	operator= (const PrimitivePatch< face, ::Foam::UList, ::Foam::SubField< point >, point > &)
	Assignment. More...

Public Member Functions inherited from UList< face >
	UList ()
	Null constructor. More...

	UList (T *__restrict__ v, label size)
	Construct from components. More...

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

std::streamsize	byteSize () const
	Return the binary size in number of characters of the UList. More...

const T *	cdata () const
	Return a const pointer to the first data element,. More...

T *	data ()
	Return a pointer to the first data element,. More...

T &	first ()
	Return the first element of the list. More...

const T &	first () const
	Return first element of the list. More...

T &	last ()
	Return the last element of the list. More...

const T &	last () const
	Return the last element of the list. More...

void	checkStart (const label start) const
	Check start is within valid range (0 ... size-1). More...

void	checkSize (const label size) const
	Check size is within valid range (0 ... size). More...

void	checkIndex (const label i) const
	Check index i is within valid range (0 ... size-1). More...

void	writeEntry (Ostream &) const
	Write the UList as a dictionary entry. More...

void	writeEntry (const word &keyword, Ostream &) const
	Write the UList as a dictionary entry with keyword. More...

void	assign (const UList< T > &)
	Assign elements to those from UList. More...

T &	operator[] (const label)
	Return element of UList. More...

const T &	operator[] (const label) const
	Return element of constant UList. More...

const bool &	operator[] (const label i) const

	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&. More...

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

iterator	begin ()
	Return an iterator to begin traversing the UList. More...

const_iterator	begin () const
	Return const_iterator to begin traversing the constant UList. More...

iterator	end ()
	Return an iterator to end traversing the UList. More...

const_iterator	end () const
	Return const_iterator to end traversing the constant UList. More...

const_iterator	cbegin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const
	Return const_iterator to end traversing the constant UList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

label	size () const
	Return the number of elements in the UList. More...

label	max_size () const
	Return size of the largest possible UList. More...

bool	empty () const
	Return true if the UList is empty (ie, size() is zero). More...

void	swap (UList< T > &)
	Swap two ULists of the same type in constant time. More...

bool	operator== (const UList< T > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< T > &) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< T > &) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< T > &) const
	Return true if !(a < b). Takes linear time. More...

Static Public Member Functions
static void	write (const fileName &, const surfMesh &)
	Write to file. More...

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

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

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

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

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

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

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

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

Static Public Member Functions inherited from PrimitivePatch< face, ::Foam::UList, ::Foam::SubField< point >, point >
static void	writeVTK (const fileName &name, const FaceListType &faces, const Field< point > &points)
	Write generic VTK patch, HJ, 14/Jan/2009. More...

static void	writeVTKNormals (const fileName &name, const FaceListType &faces, const Field< point > &points)
	Write generic VTK patch normals, HJ, 14/Jan/2009. More...

Static Public Member Functions inherited from UList< face >
static const UList< T > &	null ()
	Return a null UList. More...

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

Static Public Attributes inherited from surfaceRegistry
static const word	prefix
	The prefix to local: surfaces. More...

static word	defaultName
	The default surface name: default. More...

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

static int	fileModificationSkew

static fileCheckTypes	fileModificationChecking

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

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

surfZoneList &	storedZones ()
	Non-const access to the zones. More...

virtual void	updateFacesRef ()
	Update references to storedFaces. More...

virtual void	updatePointsRef ()
	Update references to storedPoints. More...

virtual void	updateRefs ()
	Update references to storedPoints/storedFaces. More...

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

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

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

Private Types
typedef MeshedSurfaceIOAllocator	Allocator

typedef PrimitivePatch< face, ::Foam::UList, ::Foam::SubField< point >, point >	MeshReference

Private Member Functions
	surfMesh (const surfMesh &)
	Disallow construct as copy. More...

void	operator= (const surfMesh &)
	Disallow default bitwise assignment. More...

Private Member Functions inherited from MeshedSurfaceIOAllocator
	MeshedSurfaceIOAllocator (const IOobject &ioPoints, const IOobject &ioFaces, const IOobject &ioZones)
	Read construct from IOobjects. More...

	MeshedSurfaceIOAllocator (const IOobject &ioPoints, const pointField &points, const IOobject &ioFaces, const faceList &faces, const IOobject &ioZones, const surfZoneList &zones)
	Construct from IOobjects, copying components. More...

	MeshedSurfaceIOAllocator (const IOobject &ioPoints, const Xfer< pointField > &points, const IOobject &ioFaces, const Xfer< faceList > &faces, const IOobject &ioZones, const Xfer< surfZoneList > &zones)
	Construct from IOobjects, possibly transferring components. More...

pointIOField &	storedIOPoints ()
	Non-const access to the points. More...

faceCompactIOList &	storedIOFaces ()
	Non-const access to the faces. More...

surfZoneIOList &	storedIOZones ()
	Non-const access to the zones. More...

const pointIOField &	storedIOPoints () const
	Const access to the points. More...

const faceCompactIOList &	storedIOFaces () const
	Const access to the faces. More...

const surfZoneIOList &	storedIOZones () const
	Const access to the zones. More...

void	clear ()
	Clear primitive data (points, faces and zones) More...

void	resetFaces (const Xfer< faceList > &faces, const Xfer< surfZoneList > &zones)
	Reset primitive data (points, faces and zones) More...

void	reset (const Xfer< pointField > &points, const Xfer< faceList > &faces, const Xfer< surfZoneList > &zones)
	Reset primitive data (points, faces and zones) More...

void	reset (const Xfer< List< point > > &points, const Xfer< faceList > &faces, const Xfer< surfZoneList > &zones)
	Reset primitive data (points, faces and zones) More...

Friends
template<class Face >
class	MeshedSurface

template<class Face >
class	UnsortedMeshedSurface

Additional Inherited Members
Data Fields inherited from HashTable< regIOobject * >
const typedef T &	const_reference
	Type that can be used for storing into constant. More...

Data Fields inherited from UList< face >
const typedef T &	const_reference
	Type that can be used for storing into. More...

const typedef T *	const_iterator
	Random access iterator for traversing UList. More...

const typedef T *	const_reverse_iterator
	Reverse iterator for reverse traversal of constant UList. More...

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.

Source files

Definition at line 55 of file surfMesh.H.

Member Typedef Documentation

◆ Allocator

typedef MeshedSurfaceIOAllocator Allocator

private

Definition at line 85 of file surfMesh.H.

◆ MeshReference

typedef PrimitivePatch< face, ::Foam::UList, ::Foam::SubField<point>, point > MeshReference

private

Definition at line 94 of file surfMesh.H.

◆ Mesh

typedef surfMesh Mesh

Definition at line 142 of file surfMesh.H.

◆ BoundaryMesh

typedef bool BoundaryMesh

Placeholder only, but do not remove - it is needed for GeoMesh.

Definition at line 145 of file surfMesh.H.

Member Enumeration Documentation

◆ readUpdateState

enum readUpdateState

Enumeration defining the state of the mesh after a read update.

Used for post-processing applications, where the mesh needs to update based on the files written in time directores

Enumerator
UNCHANGED
POINTS_MOVED
TOPO_CHANGE
TOPO_PATCH_CHANGE

Definition at line 72 of file surfMesh.H.

Constructor & Destructor Documentation

◆ surfMesh() [1/4]

surfMesh ( const surfMesh & )

private

Disallow construct as copy.

◆ surfMesh() [2/4]

surfMesh	(	const IOobject &	io,
		const word &	surfName = `""`
	)

explicit

Construct from IOobject, with alternative surface name.

Definition at line 74 of file surfMesh.C.

◆ surfMesh() [3/4]

surfMesh	(	const IOobject &	io,
		const Xfer< pointField > &	pointLst,
		const Xfer< faceList > &	faceLst,
		const word &	surfName = `""`
	)

Construct by transferring components (points, faces) without zones.

surfZones are added using addZones() member function

Definition at line 112 of file surfMesh.C.

◆ surfMesh() [4/4]

surfMesh	(	const IOobject &	io,
		const Xfer< MeshedSurface< face > > &	surf,
		const word &	surfName = `""`
	)

Construct copy/move from MeshedSurface.

Definition at line 158 of file surfMesh.C.

References IOobject::db(), objectRegistry::dbDir(), Foam::endl(), Foam::Info, IOobject::instance(), IOobject::local(), IOobject::name(), Foam::nl, Foam::notNull(), and IOobject::path().

Here is the call graph for this function:

◆ ~surfMesh()

~surfMesh ( )

virtual

Destructor.

Definition at line 221 of file surfMesh.C.

Member Function Documentation

◆ operator=()

void operator= ( const surfMesh & )

private

Disallow default bitwise assignment.

◆ storedPoints()

pointField& storedPoints ( )

inlineprotected

Non-const access to global points.

Definition at line 111 of file surfMesh.H.

References MeshedSurfaceIOAllocator::storedIOPoints().

Here is the call graph for this function:

◆ storedFaces()

faceList& storedFaces ( )

inlineprotected

Non-const access to the faces.

Definition at line 117 of file surfMesh.H.

References MeshedSurfaceIOAllocator::storedIOFaces().

Here is the call graph for this function:

◆ storedZones()

surfZoneList& storedZones ( )

inlineprotected

Non-const access to the zones.

Definition at line 123 of file surfMesh.H.

References MeshedSurfaceIOAllocator::storedIOZones().

Referenced by surfMesh::removeZones().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateFacesRef()

void updateFacesRef ( )

protectedvirtual

Update references to storedFaces.

Definition at line 240 of file surfMesh.C.

◆ updatePointsRef()

void updatePointsRef ( )

protectedvirtual

Update references to storedPoints.

Definition at line 230 of file surfMesh.C.

References points.

◆ updateRefs()

void updateRefs ( )

protectedvirtual

Update references to storedPoints/storedFaces.

Definition at line 247 of file surfMesh.C.

◆ TypeName()

TypeName ( "surfMesh" )

Runtime type information.

◆ meshDir()

Foam::fileName meshDir ( ) const

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

Definition at line 309 of file surfMesh.C.

◆ pointsInstance()

const Foam::fileName & pointsInstance ( ) const

Return the current instance directory for points.

Used in the consruction of geometric mesh data dependent on points

Definition at line 315 of file surfMesh.C.

◆ facesInstance()

const Foam::fileName & facesInstance ( ) const

Return the current instance directory for faces.

Definition at line 321 of file surfMesh.C.

◆ setInstance()

void setInstance ( const fileName & inst )

Set the instance for mesh files.

Definition at line 31 of file surfMeshIO.C.

References IOobject::AUTO_WRITE, Foam::endl(), Foam::Info, IOobject::instance(), MeshedSurfaceIOAllocator::storedIOFaces(), MeshedSurfaceIOAllocator::storedIOPoints(), MeshedSurfaceIOAllocator::storedIOZones(), and IOobject::writeOpt().

Here is the call graph for this function:

◆ nPoints()

Foam::label nPoints ( ) const

virtual

Return the number of raw points.

Definition at line 327 of file surfMesh.C.

References points.

◆ nFaces()

Foam::label nFaces ( ) const

virtual

Return the number of raw faces.

Definition at line 333 of file surfMesh.C.

Referenced by surfMesh::size().

Here is the caller graph for this function:

◆ size()

virtual label size ( ) const

inlinevirtual

Return number of faces.

Definition at line 210 of file surfMesh.H.

References surfMesh::nFaces().

Here is the call graph for this function:

◆ points()

const Foam::pointField & points ( ) const

virtual

Return points.

Definition at line 339 of file surfMesh.C.

Referenced by surfMesh::write().

Here is the caller graph for this function:

◆ faces()

const Foam::faceList & faces ( ) const

virtual

Return faces.

Definition at line 345 of file surfMesh.C.

Referenced by surfMesh::write().

Here is the caller graph for this function:

◆ surfZones()

virtual const surfZoneList& surfZones ( ) const

inlinevirtual

Return surface zones.

Definition at line 223 of file surfMesh.H.

References MeshedSurfaceIOAllocator::storedIOZones().

Referenced by surfMesh::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkZones()

void checkZones ( )

Check the surface zone definitions.

Definition at line 351 of file surfMesh.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, List::size(), and WarningInFunction.

Here is the call graph for this function:

◆ addZones()

void addZones	(	const List< surfZone > &	,
		const bool	validate = `true`
	)

Add surface zones.

Definition at line 391 of file surfMesh.C.

References forAll, and validate().

Here is the call graph for this function:

◆ readUpdate()

Foam::surfMesh::readUpdateState readUpdate ( )

virtual

Update the mesh based on the mesh files saved in.

time directories

Definition at line 52 of file surfMeshIO.C.

References Foam::endl(), forAll, Foam::Info, IOobject::MUST_READ, Foam::name(), Foam::nl, IOobject::NO_WRITE, surfMesh::POINTS_MOVED, List::size(), surfMesh::TOPO_CHANGE, surfMesh::TOPO_PATCH_CHANGE, List::transfer(), surfMesh::UNCHANGED, and WarningInFunction.

Here is the call graph for this function:

◆ removeZones()

void removeZones ( )

Update the mesh corresponding to given map.

Remove surface zones

Definition at line 32 of file surfMeshClear.C.

References List::clear(), surfMesh::clearOut(), Foam::endl(), Foam::Info, and surfMesh::storedZones().

Here is the call graph for this function:

◆ resetPrimitives()

void resetPrimitives	(	const Xfer< pointField > &	points,
		const Xfer< faceList > &	faces,
		const Xfer< surfZoneList > &	zones,
		const bool	validate = `true`
	)

Reset mesh primitive data.

Definition at line 255 of file surfMesh.C.

References points, and validate().

Here is the call graph for this function:

◆ transfer()

void transfer ( MeshedSurface< face > & surf )

Transfer the contents of the argument and annul the argument.

Definition at line 276 of file surfMesh.C.

References MeshedSurface::storedFaces(), MeshedSurface::storedPoints(), and MeshedSurface::storedZones().

Here is the call graph for this function:

◆ write() [1/2]

void write	(	const fileName &	name,
		const surfMesh &	surf
	)

static

Write to file.

Definition at line 426 of file surfMesh.C.

References surfMesh::faces(), Foam::name(), surfMesh::points(), surfMesh::surfZones(), and MeshedSurfaceProxy::write().

Here is the call graph for this function:

◆ write() [2/2]

void write ( const fileName & name )

Write to file.

Definition at line 437 of file surfMesh.C.

References Foam::name(), and write().

Here is the call graph for this function:

◆ xfer()

Foam::Xfer< Foam::MeshedSurface< Foam::face > > xfer ( )

Transfer contents to the Xfer container as a MeshedSurface.

Definition at line 291 of file surfMesh.C.

◆ clearGeom()

void clearGeom ( )

Clear geometry.

Definition at line 50 of file surfMeshClear.C.

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

Here is the call graph for this function:

◆ clearAddressing()

void clearAddressing ( )

Clear addressing.

Definition at line 63 of file surfMeshClear.C.

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

Here is the call graph for this function:

◆ clearOut()

void clearOut ( )

Clear all geometry and addressing unnecessary for CFD.

Definition at line 76 of file surfMeshClear.C.

Referenced by surfMesh::removeZones().

Here is the caller graph for this function:

◆ clearPrimitives()

void clearPrimitives ( )

Clear primitive data (points, faces and cells)

◆ removeFiles() [1/2]

void removeFiles ( const fileName & instanceDir ) const

Remove all files from mesh instance.

Definition at line 411 of file surfMesh.C.

References fileName::path(), and Foam::rm().

Here is the call graph for this function:

◆ removeFiles() [2/2]

void removeFiles ( ) const

Remove all files from mesh instance()

Definition at line 420 of file surfMesh.C.

Friends And Related Function Documentation

◆ MeshedSurface

friend class MeshedSurface

friend

Definition at line 62 of file surfMesh.H.

◆ UnsortedMeshedSurface

friend class UnsortedMeshedSurface

friend

Definition at line 63 of file surfMesh.H.

Field Documentation

◆ meshSubDir

Foam::word meshSubDir = "surfMesh"

static

Return the mesh sub-directory name (normally "surfMesh")

Definition at line 152 of file surfMesh.H.

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

src/surfMesh/surfMesh/surfMesh.H
src/surfMesh/surfMesh/surfMesh.C
src/surfMesh/surfMesh/surfMeshClear.C
src/surfMesh/surfMesh/surfMeshIO.C

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Allocator

◆ MeshReference

◆ Mesh

◆ BoundaryMesh

Member Enumeration Documentation

◆ readUpdateState

Constructor & Destructor Documentation

◆ surfMesh() [1/4]

◆ surfMesh() [2/4]

◆ surfMesh() [3/4]

◆ surfMesh() [4/4]

◆ ~surfMesh()

Member Function Documentation

◆ operator=()

◆ storedPoints()

◆ storedFaces()

◆ storedZones()

◆ updateFacesRef()

◆ updatePointsRef()

◆ updateRefs()

◆ TypeName()

◆ meshDir()

◆ pointsInstance()

◆ facesInstance()

◆ setInstance()

◆ nPoints()

◆ nFaces()

◆ size()

◆ points()

◆ faces()

◆ surfZones()

◆ checkZones()

◆ addZones()

◆ readUpdate()

◆ removeZones()

◆ resetPrimitives()

◆ transfer()

◆ write() [1/2]

◆ write() [2/2]

◆ xfer()

◆ clearGeom()

◆ clearAddressing()

◆ clearOut()

◆ clearPrimitives()

◆ removeFiles() [1/2]

◆ removeFiles() [2/2]

Friends And Related Function Documentation

◆ MeshedSurface

◆ UnsortedMeshedSurface

Field Documentation

◆ meshSubDir