A surface mesh consisting of general polygon faces that has IO capabilities and a registry for storing fields. More...

Inheritance diagram for surfMesh:

[legend]

Collaboration diagram for surfMesh:

[legend]

Public Types
enum	readUpdateState { UNCHANGED, POINTS_MOVED, TOPO_CHANGE, TOPO_PATCH_CHANGE }

typedef surfMesh	Mesh

typedef bool	BoundaryMesh

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

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

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

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

Public Types inherited from HashTable< regIOobject * >
typedef HashTable< T, Key, Hash >	this_type

typedef Key	key_type

typedef T	mapped_type

typedef T	value_type

typedef Hash	hasher

typedef T *	pointer

typedef T &	reference

typedef label	difference_type

typedef label	size_type

using	key_iterator = key_iterator_base< iterator >

using	const_key_iterator = key_iterator_base< const_iterator >

Public Types inherited from PrimitivePatch<::Foam::UList< face >, const pointField & >
enum	surfaceTopo

typedef std::remove_reference< ::Foam::UList< face > >::type::value_type	face_type

typedef std::remove_reference< const pointField & >::type::value_type	point_type

typedef ::Foam::UList< face >	FaceListType

typedef const pointField &	PointFieldType

typedef face_type	FaceType

Public Types inherited from UList< face >
typedef T	value_type

typedef T *	pointer

typedef T &	reference

typedef T *	iterator

typedef label	size_type

typedef label	difference_type

typedef std::reverse_iterator< iterator >	reverse_iterator

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator

Public Member Functions
	TypeName ("surfMesh")

	surfMesh (const IOobject &io)

	surfMesh (const IOobject &io, const word &surfName)

	surfMesh (const word &surfName, const objectRegistry &obr)

	surfMesh (const IOobject &io, const MeshedSurface< face > &surf, const word &surfName=word::null)

	surfMesh (const IOobject &io, MeshedSurface< face > &&surf, const word &surfName=word::null)

virtual	~surfMesh ()

fileName	meshDir () const

const fileName &	pointsInstance () const

const fileName &	facesInstance () const

void	setInstance (const fileName &inst, IOobject::writeOption wOpt=IOobject::AUTO_WRITE)

void	setWriteOption (IOobject::writeOption wOpt)

virtual label	nPoints () const

virtual label	nFaces () const

virtual label	size () const

virtual const pointField &	points () const

virtual const faceList &	faces () const

virtual const surfZoneList &	surfZones () const

const vectorField &	Sf () const

const scalarField &	magSf () const

const vectorField &	Cf () const

void	addZones (const surfZoneList &zones, bool validate=true)

void	removeZones ()

void	checkZones (const bool verbose=true)

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

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

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

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

virtual readUpdateState	readUpdate ()

template<class Type , class GeoMeshType = surfGeoMesh>
void	storeField (const word &fieldName, const dimensionSet &dims, const Field< Type > &values)

template<class Type , class GeoMeshType = surfGeoMesh>
void	storeField (const word &fieldName, const dimensionSet &dims, Field< Type > &&values)

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

void	write (const fileName &name, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const

void	write (const fileName &name, const word &fileType, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const

autoPtr< MeshedSurface< face > >	releaseGeom ()

void	clearGeom ()

void	clearAddressing ()

void	clearOut ()

void	clearPrimitives ()

void	clearFields ()

void	removeFiles (const fileName &instanceDir) const

void	removeFiles () const

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

	surfaceRegistry (const objectRegistry &obr, const word &surfName=word::null)

virtual	~surfaceRegistry ()=default

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

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

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

virtual	~objectRegistry ()

const objectRegistry &	thisDb () const noexcept

const objectRegistry &	parent () const noexcept

const Time &	time () const noexcept

bool	isTimeDb () const noexcept

virtual const fileName &	dbDir () const

HashTable< wordHashSet >	classes () const

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

label	count (const char *clsName) const

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

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

template<class Type >
label	count (const bool strict=false) const

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

wordList	names () const

wordList	names (const char *clsName) const

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

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

template<class Type >
wordList	names () const

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

wordList	sortedNames () const

wordList	sortedNames (const char *clsName) const

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

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

template<class Type >
wordList	sortedNames () const

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

template<class Type >
HashTable< const Type * >	lookupClass (const bool strict=false) const

template<class Type >
HashTable< Type * >	lookupClass (const bool strict=false)

const regIOobject *	cfindIOobject (const word &name, const bool recursive=false) const

bool	found (const word &name, const bool recursive=false) const

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

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

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

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

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

bool	checkIn (regIOobject *io) const

bool	checkIn (regIOobject &io) const

bool	checkOut (regIOobject *io) const

bool	checkOut (regIOobject &io) const

bool	checkOut (const word &key) const

void	clear ()

void	clearStorage ()

bool	erase (const iterator &iter)

bool	erase (const word &key)

label	erase (std::initializer_list< word > keys)

label	erase (const UList< word > &keys)

virtual void	rename (const word &newName)

virtual bool	modified () const

void	readModifiedObjects ()

virtual bool	readIfModified ()

virtual bool	writeData (Ostream &) const

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

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

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")

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

	regIOobject (const regIOobject &rio)

	regIOobject (const regIOobject &rio, bool registerCopy)

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

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

virtual	~regIOobject ()

bool	checkIn ()

bool	checkOut ()

virtual void	addWatch ()

bool	ownedByRegistry () const

bool	store ()

void	release (const bool unregister=false)

label	eventNo () const

label &	eventNo ()

bool	upToDate (const regIOobject &) const

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

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

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

void	setUpToDate ()

const dictionary *	findMetaData () const noexcept

dictionary &	getMetaData () noexcept

void	removeMetaData ()

virtual void	updateMetaData ()

virtual fileName	filePath () const

bool	headerOk ()

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

void	close ()

virtual bool	readData (Istream &)

virtual bool	read ()

virtual label	addWatch (const fileName &)

const labelList &	watchIndices () const

labelList &	watchIndices ()

virtual bool	write (const bool valid=true) const

virtual bool	global () const

void	operator= (const IOobject &io)

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

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

	IOobject (const IOobject &)=default

virtual	~IOobject ()=default

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

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

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

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

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

	IOobject (const IOobject &io, readOption, writeOption)

autoPtr< IOobject >	clone () const

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

const objectRegistry &	db () const noexcept

const Time &	time () const

const word &	name () const noexcept

const word &	headerClassName () const noexcept

word &	headerClassName () noexcept

const string &	note () const noexcept

string &	note () noexcept

bool	registerObject () const noexcept

bool	registerObject (bool on) noexcept

bool	globalObject () const noexcept

bool	globalObject (bool on) noexcept

unsigned	labelByteSize () const noexcept

unsigned	scalarByteSize () const noexcept

bool	isHeaderClassName (const word &clsName) const

template<class Type >
bool	isHeaderClassName () const

readOption	readOpt () const noexcept

readOption	readOpt (readOption opt) noexcept

writeOption	writeOpt () const noexcept

writeOption	writeOpt (writeOption opt) noexcept

word	group () const

word	member () const

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

fileName	path () const

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

fileName	objectPath () const

fileName	objectRelPath () const

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

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

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

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

template<class Type >
void	warnNoRereading () const

bool	writeHeader (Ostream &os) const

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

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

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

bool	good () const noexcept

bool	bad () const noexcept

InfoProxy< IOobject >	info () const

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept

writeOption &	writeOpt () noexcept

bool &	registerObject () noexcept

bool &	globalObject () noexcept

template<>
bool	isHeaderClassName () const

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

Public Member Functions inherited from HashTable< regIOobject * >
	HashTable ()

	HashTable (const label size)

	HashTable (Istream &is, const label size=128)

	HashTable (const this_type &ht)

	HashTable (this_type &&rhs)

	HashTable (std::initializer_list< std::pair< Key, T >> list)

	~HashTable ()

label	capacity () const noexcept

label	size () const noexcept

bool	empty () const noexcept

T &	at (const Key &key)

const T &	at (const Key &key) const

bool	found (const Key &key) const

iterator	find (const Key &key)

const_iterator	find (const Key &key) const

const_iterator	cfind (const Key &key) const

const T &	lookup (const Key &key, const T &deflt) const

List< Key >	toc () const

List< Key >	sortedToc () const

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

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

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

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

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

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

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

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

label	countKeys (const UnaryPredicate &pred, const bool invert=false) const

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

label	countValues (const UnaryPredicate &pred, const bool invert=false) const

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

label	countEntries (const BinaryPredicate &pred, const bool invert=false) const

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

bool	emplace (const Key &key, Args &&... args)

bool	emplace_set (const Key &key, Args &&... args)

bool	insert (const Key &key, const T &obj)

bool	insert (const Key &key, T &&obj)

bool	set (const Key &key, const T &obj)

bool	set (const Key &key, T &&obj)

bool	erase (const iterator &iter)

bool	erase (const Key &key)

label	erase (const HashTable< AnyType, Key, AnyHash > &other)

label	erase (std::initializer_list< Key > keys)

label	erase (InputIter first, InputIter last)

label	erase (const FixedList< Key, N > &keys)

label	erase (const UList< Key > &keys)

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

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

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

label	retain (const HashTable< AnyType, Key, AnyHash > &other)

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

label	filterKeys (const UnaryPredicate &pred, const bool pruning=false)

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

label	filterValues (const UnaryPredicate &pred, const bool pruning=false)

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

label	filterEntries (const BinaryPredicate &pred, const bool pruning=false)

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

void	resize (const label sz)

void	clear ()

void	clearStorage ()

void	swap (HashTable< T, Key, Hash > &rhs)

void	transfer (HashTable< T, Key, Hash > &rhs)

T &	operator[] (const Key &key)

const T &	operator[] (const Key &key) const

T &	operator() (const Key &key)

T &	operator() (const Key &key, const T &deflt)

void	operator= (const this_type &rhs)

void	operator= (std::initializer_list< std::pair< Key, T >> rhs)

void	operator= (this_type &&rhs)

bool	operator== (const this_type &rhs) const

bool	operator!= (const this_type &rhs) const

this_type &	operator+= (const this_type &rhs)

const_iterator_pair< const_key_iterator, this_type >	keys () const

iterator	begin ()

const_iterator	begin () const

const_iterator	cbegin () const

iterator	end () noexcept

const_iterator	end () const noexcept

constexpr const_iterator	cend () const noexcept

Ostream &	printInfo (Ostream &os) const

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

Public Member Functions inherited from PrimitivePatch<::Foam::UList< face >, const pointField & >
	PrimitivePatch (const ::Foam::UList< face > &faces, const const pointField & &points)

	PrimitivePatch (::Foam::UList< face > &&faces, const const pointField & &points)

	PrimitivePatch (::Foam::UList< face > &faces, const pointField & &points, const bool reuse)

	PrimitivePatch (const PrimitivePatch< ::Foam::UList< face >, const pointField & > &pp)

virtual	~PrimitivePatch ()

void	clearOut ()

void	clearGeom ()

void	clearTopology ()

void	clearPatchMeshAddr ()

void	swap (PrimitivePatch &)=delete

const Field< point_type > &	points () const noexcept

label	nFaces () const noexcept

label	nPoints () const

label	nEdges () const

const edgeList &	edges () const

const edgeList::subList	internalEdges () const

const edgeList::subList	boundaryEdges () const

label	nInternalEdges () const

label	nBoundaryEdges () const

bool	isInternalEdge (const label edgei) const

const labelList &	boundaryPoints () const

const labelListList &	faceFaces () const

const labelListList &	edgeFaces () const

const labelListList &	faceEdges () const

const labelListList &	pointEdges () const

const labelListList &	pointFaces () const

const List< face_type > &	localFaces () const

labelList	boundaryFaces () const

labelList	uniqBoundaryFaces () const

const labelList &	meshPoints () const

const Map< label > &	meshPointMap () const

const Field< point_type > &	localPoints () const

const labelList &	localPointOrder () const

label	whichPoint (const label gp) const

edge	meshEdge (const label edgei) const

edge	meshEdge (const edge &e) const

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

const Field< point_type > &	faceAreas () const

const Field< scalar > &	magFaceAreas () const

const Field< point_type > &	faceNormals () const

const Field< point_type > &	pointNormals () const

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

Foam::List< Foam::objectHit >	projectPoints (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< ::Foam::UList< face >, const 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

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

const labelListList &	edgeLoops () const

surfaceTopo	surfaceType () const

bool	checkTopology (const bool report=false, labelHashSet *setPtr=nullptr) const

bool	checkPointManifold (const bool report=false, labelHashSet *setPtr=nullptr) const

virtual void	movePoints (const Field< point_type > &)

void	operator= (const PrimitivePatch< ::Foam::UList< face >, const pointField & > &rhs)

void	operator= (PrimitivePatch< ::Foam::UList< face >, const pointField & > &&rhs)

label	whichEdge (const edge &e) const

Public Member Functions inherited from PrimitivePatchBase
	ClassName ("PrimitivePatch")

	PrimitivePatchBase ()=default

Public Member Functions inherited from UList< face >
label	size () const noexcept

void	writeEntry (const word &keyword, Ostream &os) const

void	operator= (const T &val)

void	operator= (const Foam::zero)

	UList (const UList< T > &)=default

constexpr	UList () noexcept

	UList (T *__restrict__ v, const label len) noexcept

label	fcIndex (const label i) const noexcept

label	rcIndex (const label i) const noexcept

const T &	fcValue (const label i) const

T &	fcValue (const label i)

const T &	rcValue (const label i) const

T &	rcValue (const label i)

const T *	cdata () const noexcept

T *	data () noexcept

const char *	cdata_bytes () const noexcept

char *	data_bytes () noexcept

T &	first ()

const T &	first () const

T &	last ()

const T &	last () const

std::streamsize	size_bytes () const noexcept

std::streamsize	byteSize () const

void	checkStart (const label start) const

void	checkSize (const label size) const

void	checkRange (const label start, const label len) const

void	checkIndex (const label i) const

bool	uniform () const

label	find (const T &val, label pos=0) const

label	rfind (const T &val, label pos=-1) const

bool	found (const T &val, label pos=0) const

void	moveFirst (const label i)

void	moveLast (const label i)

void	swapFirst (const label i)

void	swapLast (const label i)

void	shallowCopy (const UList< T > &list)

void	deepCopy (const UList< T > &list)

void	deepCopy (const IndirectListBase< T, Addr > &list)

void	deepCopy (const UList< T > &list)

SubList< T >	slice (const label pos, label len=-1)

const SubList< T >	slice (const label pos, label len=-1) const

SubList< T >	slice (const labelRange &range)

const SubList< T >	slice (const labelRange &range) const

T &	operator[] (const label i)

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

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

Foam::UPstream::commsStruct &	operator[] (const label procID)

const Foam::UPstream::commsStruct &	operator[] (const label procID) const

UPstream::commsStruct &	operator[] (const label)

const UPstream::commsStruct &	operator[] (const label) const

	operator const Foam::List< T > & () const

iterator	begin () noexcept

const_iterator	begin () const noexcept

iterator	end () noexcept

const_iterator	end () const noexcept

const_iterator	cbegin () const noexcept

const_iterator	cend () const noexcept

reverse_iterator	rbegin ()

const_reverse_iterator	rbegin () const

reverse_iterator	rend ()

const_reverse_iterator	rend () const

const_reverse_iterator	crbegin () const

const_reverse_iterator	crend () const

bool	empty () const noexcept

void	swap (UList< T > &list)

bool	operator== (const UList< T > &a) const

bool	operator!= (const UList< T > &a) const

bool	operator< (const UList< T > &list) const

bool	operator> (const UList< T > &a) const

bool	operator<= (const UList< T > &a) const

bool	operator>= (const UList< T > &a) const

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

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

Ostream &	writeList (Ostream &os, const label) const

Ostream &	writeList (Ostream &os, const label) const

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	test (const label i) const

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	get (const label i) const

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	unset (const label i)

Static Public Attributes
static word	meshSubDir = "surfMesh"

Static Public Attributes inherited from surfaceRegistry
static const word	prefix

static word	defaultName

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

static char	scopeSeparator

static fileCheckTypes	fileModificationChecking

static float	fileModificationSkew

static int	maxFileModificationPolls

Protected Member Functions
pointField &	storedPoints ()

faceList &	storedFaces ()

surfZoneList &	storedZones ()

void	updateRefs ()

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

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

Protected Member Functions inherited from HashTable< regIOobject * >
bool	iterator_erase (node_type *&entry, label &index)

Protected Member Functions inherited from UList< face >
void	setAddressableSize (const label n) noexcept

void	size (const label n)

void	writeEntry (Ostream &os) const

void	writeEntry (Ostream &os) const

void	writeEntry (Ostream &os) const

labelRange	validateRange (const labelRange &requestedRange) const

UList< T > &	operator= (const UList< T > &)=delete

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

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

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

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

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

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

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

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

static bool	bannerEnabled (bool on) noexcept

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

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

static word	group (const word &name)

static word	member (const word &name)

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

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

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

static Ostream &	writeDivider (Ostream &os)

static Ostream &	writeEndDivider (Ostream &os)

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

static constexpr label	max_size () noexcept

Public Attributes inherited from HashTable< regIOobject * >
const typedef T *	const_pointer

const typedef T &	const_reference

Public Attributes inherited from UList< face >
const typedef T *	const_pointer

const typedef T &	const_reference

const typedef T *	const_iterator

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

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

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false

Detailed Description

A surface mesh consisting of general polygon faces that has IO capabilities and a registry for storing fields.

Source files

Definition at line 59 of file surfMesh.H.

Member Typedef Documentation

◆ Mesh

typedef surfMesh Mesh

Definition at line 139 of file surfMesh.H.

◆ BoundaryMesh

typedef bool BoundaryMesh

Definition at line 142 of file surfMesh.H.

Member Enumeration Documentation

◆ readUpdateState

enum readUpdateState

Enumerator
UNCHANGED
POINTS_MOVED
TOPO_CHANGE
TOPO_PATCH_CHANGE

Definition at line 72 of file surfMesh.H.

Constructor & Destructor Documentation

◆ surfMesh() [1/5]

surfMesh ( const IOobject & io )

explicit

Definition at line 75 of file surfMesh.C.

◆ surfMesh() [2/5]

surfMesh	(	const IOobject &	io,
		const word &	surfName
	)

Definition at line 81 of file surfMesh.C.

◆ surfMesh() [3/5]

surfMesh	(	const word &	surfName,
		const objectRegistry &	obr
	)

Definition at line 123 of file surfMesh.C.

◆ surfMesh() [4/5]

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

Definition at line 168 of file surfMesh.C.

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

Here is the call graph for this function:

◆ surfMesh() [5/5]

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

Definition at line 224 of file surfMesh.C.

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

Here is the call graph for this function:

◆ ~surfMesh()

~surfMesh ( )

virtual

Definition at line 282 of file surfMesh.C.

Member Function Documentation

◆ storedPoints()

pointField& storedPoints ( )

inlineprotected

Definition at line 113 of file surfMesh.H.

References MeshedSurfaceIOAllocator::storedIOPoints().

Here is the call graph for this function:

◆ storedFaces()

faceList& storedFaces ( )

inlineprotected

Definition at line 119 of file surfMesh.H.

References MeshedSurfaceIOAllocator::storedIOFaces().

Referenced by surfMesh::updateRefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storedZones()

surfZoneList& storedZones ( )

inlineprotected

Definition at line 125 of file surfMesh.H.

◆ updateRefs()

void updateRefs ( )

protected

Definition at line 63 of file surfMesh.C.

References UList::shallowCopy(), and surfMesh::storedFaces().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "surfMesh" )

◆ meshDir()

Foam::fileName meshDir ( ) const

Definition at line 419 of file surfMesh.C.

◆ pointsInstance()

const Foam::fileName & pointsInstance ( ) const

Definition at line 425 of file surfMesh.C.

◆ facesInstance()

const Foam::fileName & facesInstance ( ) const

Definition at line 431 of file surfMesh.C.

◆ setInstance()

void setInstance	(	const fileName &	inst,
		IOobject::writeOption	wOpt = `IOobject::AUTO_WRITE`
	)

Definition at line 28 of file surfMeshIO.C.

References DebugInFunction, and Foam::endl().

Here is the call graph for this function:

◆ setWriteOption()

void setWriteOption ( IOobject::writeOption wOpt )

Definition at line 43 of file surfMeshIO.C.

References MeshedSurfaceIOAllocator::setWriteOption(), and IOobject::writeOpt().

Here is the call graph for this function:

◆ nPoints()

Foam::label nPoints ( ) const

virtual

Definition at line 437 of file surfMesh.C.

References points.

◆ nFaces()

Foam::label nFaces ( ) const

virtual

Definition at line 443 of file surfMesh.C.

Referenced by surfMesh::size().

Here is the caller graph for this function:

◆ size()

virtual label size ( ) const

inlinevirtual

Definition at line 220 of file surfMesh.H.

References surfMesh::nFaces().

Here is the call graph for this function:

◆ points()

const Foam::pointField & points ( ) const

virtual

Definition at line 449 of file surfMesh.C.

◆ faces()

const Foam::faceList & faces ( ) const

virtual

Definition at line 455 of file surfMesh.C.

◆ surfZones()

virtual const surfZoneList& surfZones ( ) const

inlinevirtual

Definition at line 233 of file surfMesh.H.

◆ Sf()

const vectorField& Sf ( ) const

inline

Definition at line 239 of file surfMesh.H.

References PrimitivePatch<::Foam::UList< face >, const pointField & >::faceAreas().

Here is the call graph for this function:

◆ magSf()

const scalarField& magSf ( ) const

inline

Definition at line 245 of file surfMesh.H.

References PrimitivePatch<::Foam::UList< face >, const pointField & >::magFaceAreas().

Here is the call graph for this function:

◆ Cf()

const vectorField& Cf ( ) const

inline

Definition at line 251 of file surfMesh.H.

References PrimitivePatch<::Foam::UList< face >, const pointField & >::faceCentres().

Here is the call graph for this function:

◆ addZones()

void addZones	(	const surfZoneList &	zones,
		bool	validate = `true`
	)

Definition at line 523 of file surfMesh.C.

References forAll, and Foam::stringOps::validate().

Here is the call graph for this function:

◆ removeZones()

void removeZones ( )

Definition at line 27 of file surfMeshClear.C.

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

Here is the call graph for this function:

◆ checkZones()

void checkZones ( const bool verbose = true )

Definition at line 461 of file surfMesh.C.

References Foam::nl, surfZone::size(), surfZone::start(), and WarningInFunction.

Here is the call graph for this function:

◆ copySurface() [1/3]

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

Definition at line 291 of file surfMesh.C.

References List::clear(), nPoints, and points.

Referenced by sampledSurface::storeSurfMesh().

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	validate = `false`
	)

Definition at line 320 of file surfMesh.C.

References List::clear(), meshedSurf::faces(), nPoints, and meshedSurf::points().

Here is the call graph for this function:

◆ copySurface() [3/3]

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

Definition at line 348 of file surfMesh.C.

References nPoints, MeshedSurface::size(), MeshedSurface::surfFaces(), MeshedSurface::surfZones(), and Foam::stringOps::validate().

Here is the call graph for this function:

◆ transfer()

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

Definition at line 379 of file surfMesh.C.

References MeshedSurface::storedFaces(), MeshedSurface::storedPoints(), MeshedSurface::storedZones(), and Foam::stringOps::validate().

Here is the call graph for this function:

◆ readUpdate()

Foam::surfMesh::readUpdateState readUpdate ( )

virtual

Definition at line 51 of file surfMeshIO.C.

References DebugInfo, DebugInFunction, Foam::endl(), forAll, IOobject::MUST_READ, Foam::name(), Foam::nl, IOobject::NO_WRITE, surfMesh::POINTS_MOVED, IOobject::READ_IF_PRESENT, surfMesh::TOPO_CHANGE, surfMesh::TOPO_PATCH_CHANGE, surfMesh::UNCHANGED, and WarningInFunction.

Here is the call graph for this function:

◆ storeField() [1/2]

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

Definition at line 28 of file surfMeshTemplates.C.

References DimensionedField::dimensions(), objectRegistry::getObjectPtr(), and Foam::HashTableOps::values().

Referenced by sampledSurface::storeSurfMeshField().

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
	)

Definition at line 68 of file surfMeshTemplates.C.

References DimensionedField::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

Reimplemented from MeshedSurfaceIOAllocator.

Definition at line 188 of file surfMeshIO.C.

◆ write() [1/2]

void write	(	const fileName &	name,
		IOstreamOption	streamOpt = `IOstreamOption()`,
		const dictionary &	options = `dictionary::null`
	)		const

Definition at line 560 of file surfMesh.C.

References word::ext(), Foam::name(), and Foam::vtk::write().

Here is the call graph for this function:

◆ write() [2/2]

void write	(	const fileName &	name,
		const word &	fileType,
		IOstreamOption	streamOpt = `IOstreamOption()`,
		const dictionary &	options = `dictionary::null`
	)		const

Definition at line 571 of file surfMesh.C.

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

Here is the call graph for this function:

◆ releaseGeom()

Foam::autoPtr< Foam::MeshedSurface< Foam::face > > releaseGeom ( )

Definition at line 400 of file surfMesh.C.

References Foam::New().

Here is the call graph for this function:

◆ clearGeom()

void clearGeom ( )

Definition at line 40 of file surfMeshClear.C.

References DebugInFunction, and Foam::endl().

Here is the call graph for this function:

◆ clearAddressing()

void clearAddressing ( )

Definition at line 48 of file surfMeshClear.C.

References DebugInFunction, and Foam::endl().

Here is the call graph for this function:

◆ clearOut()

void clearOut ( )

Definition at line 56 of file surfMeshClear.C.

Referenced by surfMesh::removeZones().

Here is the caller graph for this function:

◆ clearPrimitives()

void clearPrimitives ( )

◆ clearFields()

void clearFields ( )

Definition at line 65 of file surfMeshClear.C.

References objectRegistry::clear().

Here is the call graph for this function:

◆ removeFiles() [1/2]

void removeFiles ( const fileName & instanceDir ) const

Definition at line 543 of file surfMesh.C.

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

Here is the call graph for this function:

◆ removeFiles() [2/2]

void removeFiles ( ) const

Definition at line 553 of file surfMesh.C.

Member Data Documentation

◆ meshSubDir

Foam::word meshSubDir = "surfMesh"

static

Definition at line 149 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
src/surfMesh/surfMesh/surfMeshTemplates.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

◆ readUpdateState

Constructor & Destructor Documentation

◆ surfMesh() [1/5]

◆ surfMesh() [2/5]

◆ surfMesh() [3/5]

◆ surfMesh() [4/5]

◆ surfMesh() [5/5]

◆ ~surfMesh()

Member Function Documentation

◆ storedPoints()

◆ storedFaces()

◆ storedZones()

◆ updateRefs()

◆ TypeName()

◆ meshDir()

◆ pointsInstance()

◆ facesInstance()

◆ setInstance()

◆ setWriteOption()

◆ nPoints()

◆ nFaces()

◆ size()

◆ points()

◆ faces()

◆ surfZones()

◆ Sf()

◆ magSf()

◆ Cf()

◆ addZones()

◆ removeZones()

◆ checkZones()

◆ copySurface() [1/3]

◆ copySurface() [2/3]

◆ copySurface() [3/3]

◆ transfer()

◆ readUpdate()

◆ storeField() [1/2]

◆ storeField() [2/2]

◆ writeObject()

◆ write() [1/2]

◆ write() [2/2]

◆ releaseGeom()

◆ clearGeom()

◆ clearAddressing()

◆ clearOut()

◆ clearPrimitives()

◆ clearFields()

◆ removeFiles() [1/2]

◆ removeFiles() [2/2]

Member Data Documentation

◆ meshSubDir