Class containing Lagrangian geometry and topology. More...

Inheritance diagram for LagrangianMesh:

Collaboration diagram for LagrangianMesh:

[legend]

Classes
class	changer
	Class to define the scope of Lagrangian mesh state changes. More...

class	elementGroup
	Class to hold element-group indices, and associate the group. More...

class	linearDisplacement
	Class to hold and index into the field references associated with a. More...

class	parabolicDisplacement
	Class to hold and index into the field references associated with a. More...

Public Types
enum class	permutationAlgorithm { copy , inPlace }
	Enumeration of the permutation algorithm. More...

enum class	partitioningAlgorithm { bin , quick }
	Enumeration of the partitioning algorithm. More...

enum class	location { inCell , onBoundary , outsideMesh }
	Enumeration for the locations of searched positions. More...

typedef LagrangianMesh	Mesh
	Mesh type. More...

typedef LagrangianBoundaryMesh	BoundaryMesh
	Boundary mesh type. More...

template<class Type >
using	PatchField = LagrangianPatchField< Type >
	Patch field type. More...

template<class Type >
using	FieldSource = LagrangianFieldSource< Type >
	Field source type. 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...

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

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

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

typedef const regIOobject * &	const_reference
	Type that can be used for storing into constant. More...

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

Public Types inherited from GeoMesh< polyMesh >
typedef polyMesh	Mesh
	Mesh type. More...

typedef MESH::BoundaryMesh	BoundaryMesh
	Boundary mesh type. More...

Public Member Functions
	ClassName ("LagrangianMesh")
	Run-time type information. More...

	LagrangianMesh (const polyMesh &mesh, const word &name, const IOobject::readOption readOption=IOobject::READ_IF_PRESENT, const IOobject::writeOption writeOption=IOobject::AUTO_WRITE)
	Construct from a mesh and a name. More...

	LagrangianMesh (const polyMesh &mesh, const word &name, const wordList &wantedPatchTypes, const IOobject::readOption readOption=IOobject::READ_IF_PRESENT, const IOobject::writeOption writeOption=IOobject::AUTO_WRITE)
	Construct from a mesh and a name and a list of patch types. More...

	LagrangianMesh (const LagrangianMesh &)=delete
	Disallow default bitwise copy construction. More...

	~LagrangianMesh ()
	Destructor. More...

const polyMesh &	mesh () const
	Access the mesh. More...

const barycentricIODynamicField &	coordinates () const
	Access the coordinates. More...

const labelIODynamicField &	celli () const
	Access the cell indices. More...

const labelIODynamicField &	facei () const
	Access the cell-face indices. More...

const labelIODynamicField &	faceTrii () const
	Access the face-tet indices. More...

const LagrangianBoundaryMesh &	boundary () const
	Return reference to boundary mesh. More...

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

const List< LagrangianState > &	states () const
	Return the states. More...

List< LagrangianState > &	states ()
	Access the states. More...

LagrangianState	state (const label i) const
	Return the state for an element of the mesh, or a none state. More...

LagrangianState	state (const LagrangianSubMesh &subMesh, const label subi) const
	Return the state for an element of a sub mesh, or a none state. More...

label	subMeshIndex () const
	Get a sub-mesh index. More...

const LagrangianSchemes &	schemes () const
	Access the schemes. More...

const LagrangianSolution &	solution () const
	Access the solution controls. More...

template<class GeoField >
HashTable< const GeoField * >	lookupCurrentFields (const bool strict=false) const
	Lookup all current-time fields of the given type. More...

template<class GeoField >
HashTable< GeoField * >	lookupCurrentFields (const bool strict=false)
	Lookup all current-time fields of the given type. More...

label	size () const
	Get the number of elements. More...

label	globalSize () const
	Get the global number of elements. More...

label	nStates () const
	Return the number of states. More...

label	nGroups () const
	Return the number of groups. More...

label	stateToGroupi (const LagrangianState state) const
	Convert a state to a group index. More...

LagrangianSubMesh	sub (const LagrangianGroup group) const
	Return a sub-mesh for the given group. More...

LagrangianSubMesh	subNone () const
	Return a sub-mesh for no elements. More...

const LagrangianSubMesh &	subAll () const
	Return a sub-mesh for all elements. More...

LagrangianSubMesh	subIncomplete () const
	Return a sub-mesh for all incomplete elements. More...

labelList	subMeshGlobalSizes () const
	Return the global sizes of all the sub-meshes. A value of -1. More...

tmp< LagrangianVectorInternalField >	position () const
	Return the global positions. More...

point	position (const label i) const
	Return the global position of an element. More...

location	locate (const point &position, barycentric &coordinates, label &celli, label &facei, label &faceTrii, const scalar fraction) const
	Convert a position into a set of coordinates and a. More...

List< location >	locate (const List< point > &position, List< barycentric > &coordinates, labelList &celli, labelList &facei, labelList &faceTrii, const scalarList &fraction) const
	Convert set of positions into a set of coordinates and a. More...

void	partition ()
	Partition the mesh such that the groups are contiguous in memory. More...

template<class Displacement >
void	track (const List< LagrangianState > &endState, const Displacement &displacement, const LagrangianSubScalarField &deltaFraction, LagrangianSubScalarSubField &fraction)
	Track the positions along the given displacements. More...

void	crossFaces (const LagrangianScalarInternalDynamicField &fraction)
	Cross the faces. More...

template<class ... FieldNamesAndFields>
LagrangianSubMesh	inject (const barycentricField &coordinates, const labelField &celli, const labelField &facei, const labelField &faceTrii, const FieldNamesAndFields &... fieldNamesAndFields)
	Inject specified elements into the mesh. This method does not. More...

template<class ... FieldNamesAndFields>
LagrangianSubMesh	inject (const LagrangianInjection &injection, const barycentricField &coordinates, const labelField &celli, const labelField &facei, const labelField &faceTrii, const FieldNamesAndFields &... fieldNamesAndFields)
	Inject specified elements into the mesh. Fields are expanded. More...

template<class ... FieldNamesAndFields>
LagrangianSubMesh	birth (const labelList &parents, const FieldNamesAndFields &... fieldNamesAndFields)
	Birth specified elements into the mesh. Fields are expanded. More...

void	reset (const bool initial, const bool final)
	Reset the mesh to the old-time conditions. More...

void	clear ()
	Clear all geometry out of the Lagrangian mesh. More...

labelList	partition (const label nGroups, const UList< labelPair > &elementsGroups)
	Manually partition a sub-set of the mesh given a list of. More...

template<class Enumeration >
labelList	partition (const label nGroups, const UList< elementGroup< Enumeration >> &elementsGroups)
	As above but for enumerated groups. More...

void	remove (const UList< label > &elements)
	Remove specified elements from the mesh. Shuffles everything. More...

void	remove (const label nElements)
	Remove a specified number of elements from the end of the mesh. More...

virtual void	clearPosition ()
	Clear the positions uses during mapping. More...

virtual void	storePosition ()
	Store the positions for use during mapping. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

virtual bool	writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp, const bool write=true) const
	Write using given format, version and compression. More...

virtual bool	write (const bool write=true) const
	Write settings from the database. More...

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

template<class Type , class ... FieldNamesAndFields>
Foam::wordHashSet	appendSpecifiedFields (const LagrangianSubMesh &appendMesh, const word &fieldName, const Field< Type > &field, const FieldNamesAndFields &... fieldNamesAndFields) const

template<class GeoField >
Foam::HashTable< const GeoField * >	lookupCurrentFields (const bool strict) const

template<class GeoField >
Foam::HashTable< GeoField * >	lookupCurrentFields (const bool strict)

template<class ... FieldNamesAndFields>
Foam::LagrangianSubMesh	inject (const barycentricField &coordinates, const labelField &celli, const labelField &facei, const labelField &faceTrii, const FieldNamesAndFields &... fieldNamesAndFields)

template<class ... FieldNamesAndFields>
Foam::LagrangianSubMesh	inject (const LagrangianInjection &injection, const barycentricField &coordinates, const labelField &celli, const labelField &facei, const labelField &faceTrii, const FieldNamesAndFields &... fieldNamesAndFields)

template<class ... FieldNamesAndFields>
Foam::LagrangianSubMesh	birth (const labelList &parents, const FieldNamesAndFields &... fieldNamesAndFields)

template<class Enumeration >
Foam::labelList	partition (const label nGroups, const UList< elementGroup< Enumeration >> &elementsGroups)

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

const objectRegistry &	thisDb () const
	Return the object registry. 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 fileName &dbDir, const label nIoObjects=128)
	Construct a sub-registry given an IObject to describe the registry. More...

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

	objectRegistry (objectRegistry &&)=default
	Move constructor. More...

	objectRegistry (const objectRegistry &)=delete
	Disallow default bitwise copy construction. More...

virtual	~objectRegistry ()
	Destructor. More...

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

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

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

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

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

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

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

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

template<class Type >
wordList	toc (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 in registry. More...

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

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

template<class Type >
bool	foundType (const word &group=word::null) const
	Is the Type in registry. More...

template<class Type >
const Type &	lookupType (const word &group=word::null) const
	Lookup and return the object of the given Type. More...

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

const objectRegistry &	thisDb () const
	Return the object registry. 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...

void	clear ()
	Remove all regIOobject owned by the registry. More...

bool	cacheTemporaryObject (const word &name) const
	Return true if given name is in the cacheTemporaryObjects set. More...

template<class Object >
bool	cacheTemporaryObject (Object &ob) const
	Cache the given object. More...

void	resetCacheTemporaryObject (const regIOobject &ob) const
	Reset the cache state of the given object. More...

bool	checkCacheTemporaryObjects () const
	Check that all objects in the cacheTemporaryObjects set. More...

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

virtual bool	dependenciesModified () const
	Cache pointers to objects who's dependencies have been modified. More...

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

virtual bool	read ()
	Read dependent objects. More...

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

void	printToc (Ostream &os) const
	Print the list of object names and their type. More...

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

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

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

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

template<class Type >
Foam::wordList	toc (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)

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

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 &)
	Copy constructor. More...

	regIOobject (regIOobject &&)
	Move constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

virtual bool	global () const
	Return true if object is global, i.e. same for all processors. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

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

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

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

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

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

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const
	Is this object registered with the 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...

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

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

void	close ()
	Close Istream. More...

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

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

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

void	operator= (const IOobject &)=delete
	Assign to IOobject. More...

void	operator= (const regIOobject &)=delete
	Disallow default assignment. More...

const fileName &	caseName (const bool global) const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

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

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 objectRegistry &registry)
	Construct from copy resetting registry. More...

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

	IOobject (const IOobject &io)=default
	Copy constructor. More...

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

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. 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...

word &	headerClassName ()
	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 bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

void	updateTimeInstance () const
	Update instance to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	relativePath () const
	Return the path relative to the case directory. More...

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

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

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

bool	headerOk ()
	Read header of local object without type-checking. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. 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 word &, const regIOobject * &newElmt)
	Set a new hashedEntry, overwriting existing entries. More...

void	set (const HashTable< regIOobject *, word, string::hash > &)
	Insert all the entries from the given HashTable,. More...

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

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

	HashTable (const UList< word > &keyList, const UList< regIOobject * > &elmtList)
	Construct from a list of keys and list of elements. More...

	HashTable (const HashTable< regIOobject *, word, string::hash > &)
	Copy constructor. More...

	HashTable (HashTable< regIOobject *, word, string::hash > &&)
	Move constructor. More...

	HashTable (std::initializer_list< Tuple2< word, regIOobject * >>)
	Construct from an initialiser list. 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 word &) const
	Return true if hashedEntry is found in table. More...

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

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

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

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

List< const_iterator >	sorted () const
	Return a sorted list of constant iterators. More...

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

bool	insert (const word &, const regIOobject * &newElmt)
	Insert a new hashedEntry. More...

void	insert (const HashTable< regIOobject *, word, string::hash > &)
	Insert all the entries from the given HashTable. More...

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

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

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

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

Foam::label	erase (const HashTable< AnyType, word, 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< regIOobject *, word, string::hash > &)
	Transfer the contents of the argument table into this table. More...

regIOobject * &	operator[] (const word &)
	Find and return a hashedEntry. More...

const regIOobject * &	operator[] (const word &) const
	Find and return a hashedEntry. More...

regIOobject * &	operator() (const word &)
	Find and return a hashedEntry, create it null if not present. More...

void	operator= (const HashTable< regIOobject *, word, string::hash > &)
	Assignment operator. More...

void	operator= (HashTable< regIOobject *, word, string::hash > &&)
	Move assignment operator. More...

void	operator= (std::initializer_list< Tuple2< word, regIOobject * >>)
	Assignment to an initialiser list. More...

bool	operator== (const HashTable< regIOobject *, word, string::hash > &) const
	Equality. Hash tables are equal if the keys and values are equal. More...

bool	operator!= (const HashTable< regIOobject *, word, string::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 HashTableCore
	HashTableCore ()
	Construct null. More...

	ClassName ("HashTable")
	Define template name and debug. More...

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

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

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

Static Public Member Functions
static label	size (const LagrangianMesh &mesh)
	Return size. 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)

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

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

template<class 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 Public Member Functions inherited from HashTableCore
static label	canonicalSize (const label)
	Return a canonical (power-of-two) size. More...

static iteratorEnd	cend ()
	iteratorEnd set to beyond the end of any HashTable More...

static iteratorEnd	end ()
	iteratorEnd set to beyond the end of any HashTable More...

Static Public Attributes
static const NamedEnum< permutationAlgorithm, 2 >	permutationAlgorithmNames_ {"copy", "inPlace"}
	Permutation algorithm names. More...

static const NamedEnum< partitioningAlgorithm, 2 >	partitioningAlgorithmNames_ {"bin", "quick"}
	Partitioning algorithm names. More...

static const word	prefix
	Instance prefix. More...

static const word	coordinatesName
	Name of the coordinates field. More...

static const word	positionName
	Name of the position field. More...

static const word	stateName
	Name of the state field. More...

static const word	fractionName
	Name of the tracked fraction field. More...

static permutationAlgorithm	permutationAlgorithm_
	Permutation algorithm. More...

static partitioningAlgorithm	partitioningAlgorithm_
	Partitioning algorithm. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

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

Static Public Attributes inherited from HashTableCore
static const label	maxTableSize
	Maximum allowable table size. More...

Friends
class	nonConformalCyclicLagrangianPatch
	The non-conformal cyclic patch needs to access the receiving. More...

class	processorLagrangianPatch
	The processor patch communicates and adds elements to the receiving. More...

template<class Type >
class	processorLagrangianPatchField
	See above. More...

class	nonConformalProcessorCyclicLagrangianPatch
	See above. More...

template<class Type >
class	nonConformalProcessorCyclicLagrangianPatchField
	See above. More...

Additional Inherited Members
Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

Protected Member Functions inherited from IOobject
template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

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

Detailed Description

Class containing Lagrangian geometry and topology.

Source files

Definition at line 64 of file LagrangianMesh.H.

Member Typedef Documentation

◆ Mesh

typedef LagrangianMesh Mesh

Mesh type.

Definition at line 554 of file LagrangianMesh.H.

◆ BoundaryMesh

typedef LagrangianBoundaryMesh BoundaryMesh

Boundary mesh type.

Definition at line 557 of file LagrangianMesh.H.

◆ PatchField

using PatchField = LagrangianPatchField<Type>

Patch field type.

Definition at line 561 of file LagrangianMesh.H.

◆ FieldSource

using FieldSource = LagrangianFieldSource<Type>

Field source type.

Definition at line 565 of file LagrangianMesh.H.

Member Enumeration Documentation

◆ permutationAlgorithm

enum permutationAlgorithm

strong

Enumeration of the permutation algorithm.

Enumerator
copy
inPlace

Definition at line 74 of file LagrangianMesh.H.

◆ partitioningAlgorithm

enum partitioningAlgorithm

strong

Enumeration of the partitioning algorithm.

Enumerator
bin
quick

Definition at line 85 of file LagrangianMesh.H.

◆ location

enum location

strong

Enumeration for the locations of searched positions.

Enumerator
inCell
onBoundary
outsideMesh

Definition at line 96 of file LagrangianMesh.H.

Constructor & Destructor Documentation

◆ LagrangianMesh() [1/3]

LagrangianMesh	(	const polyMesh &	mesh,
		const word &	name,
		const IOobject::readOption	readOption = `IOobject::READ_IF_PRESENT`,
		const IOobject::writeOption	writeOption = `IOobject::AUTO_WRITE`
	)

Construct from a mesh and a name.

Definition at line 931 of file LagrangianMesh.C.

◆ LagrangianMesh() [2/3]

LagrangianMesh	(	const polyMesh &	mesh,
		const word &	name,
		const wordList &	wantedPatchTypes,
		const IOobject::readOption	readOption = `IOobject::READ_IF_PRESENT`,
		const IOobject::writeOption	writeOption = `IOobject::AUTO_WRITE`
	)

Construct from a mesh and a name and a list of patch types.

Definition at line 950 of file LagrangianMesh.C.

References IOobject::AUTO_WRITE, primitiveMesh::cells(), UList< T >::empty(), forAll, IOobject::name(), polyMesh::oldCellCentres(), IOobject::READ_IF_PRESENT, List< T >::size(), polyMesh::tetBasePtIs(), LagrangianMesh::time(), and IOobject::writeOpt().

Here is the call graph for this function:

◆ LagrangianMesh() [3/3]

LagrangianMesh ( const LagrangianMesh & )

delete

Disallow default bitwise copy construction.

◆ ~LagrangianMesh()

~LagrangianMesh ( )

Destructor.

Definition at line 1160 of file LagrangianMesh.C.

Member Function Documentation

◆ ClassName()

ClassName ( "LagrangianMesh" )

Run-time type information.

◆ mesh()

const Foam::polyMesh & mesh ( ) const

inline

Access the mesh.

Definition at line 63 of file LagrangianMeshI.H.

Referenced by LagrangianFieldDecomposer::LagrangianFieldDecomposer(), LagrangianFieldReconstructor::LagrangianFieldReconstructor(), LagrangianMesh::locate(), LagrangianSubMesh::nf(), LagrangianSubMesh::Uf(), carrierLagrangianFieldSource< Type >::value(), and totalPressureVelocityLagrangianVectorFieldSource::value().

Here is the caller graph for this function:

◆ coordinates()

const Foam::barycentricIODynamicField & coordinates ( ) const

inline

Access the coordinates.

Definition at line 70 of file LagrangianMeshI.H.

Referenced by cellPointLagrangianAccumulator::accumulate(), LagrangianFieldDecomposer::LagrangianFieldDecomposer(), LagrangianMesh::locate(), LagrangianSubMesh::nf(), and LagrangianSubMesh::Uf().

Here is the caller graph for this function:

◆ celli()

const Foam::labelIODynamicField & celli ( ) const

inline

Access the cell indices.

Definition at line 76 of file LagrangianMeshI.H.

Referenced by cellPointLagrangianAccumulator::accumulate(), LagrangianFieldDecomposer::LagrangianFieldDecomposer(), LagrangianMesh::locate(), LagrangianSubMesh::nf(), and LagrangianSubMesh::Uf().

Here is the caller graph for this function:

◆ facei()

const Foam::labelIODynamicField & facei ( ) const

inline

Access the cell-face indices.

Definition at line 82 of file LagrangianMeshI.H.

Referenced by cellPointLagrangianAccumulator::accumulate(), LagrangianFieldDecomposer::LagrangianFieldDecomposer(), LagrangianMesh::locate(), LagrangianSubMesh::nf(), and LagrangianSubMesh::Uf().

Here is the caller graph for this function:

◆ faceTrii()

const Foam::labelIODynamicField & faceTrii ( ) const

inline

Access the face-tet indices.

Definition at line 88 of file LagrangianMeshI.H.

Referenced by cellPointLagrangianAccumulator::accumulate(), LagrangianFieldDecomposer::LagrangianFieldDecomposer(), LagrangianMesh::locate(), LagrangianSubMesh::nf(), and LagrangianSubMesh::Uf().

Here is the caller graph for this function:

◆ boundary()

const Foam::LagrangianBoundaryMesh & boundary ( ) const

inline

Return reference to boundary mesh.

Definition at line 95 of file LagrangianMeshI.H.

Referenced by LagrangianMesh::changer::changer(), LagrangianMesh::crossFaces(), LagrangianMesh::partition(), cloudFunctionObjectUList::preCrossFaces(), and LagrangianMesh::subMeshGlobalSizes().

Here is the caller graph for this function:

◆ changing()

bool changing ( ) const

inline

Return whether or not the mesh is changing.

Definition at line 101 of file LagrangianMeshI.H.

◆ states() [1/2]

const Foam::List< Foam::LagrangianState > & states ( ) const

inline

Return the states.

Definition at line 108 of file LagrangianMeshI.H.

Referenced by LagrangianMesh::changer::changer(), LagrangianMesh::clear(), LagrangianMesh::crossFaces(), cloudVelocityLagrangianPatch::evaluate(), emptyLagrangianPatch::evaluate(), symmetryLagrangianPatch::evaluate(), symmetryPlaneLagrangianPatch::evaluate(), LagrangianPatch::evaluate(), LagrangianMesh::partition(), and LagrangianMesh::track().

Here is the caller graph for this function:

◆ states() [2/2]

Foam::List< Foam::LagrangianState > & states ( )

inline

Access the states.

Definition at line 115 of file LagrangianMeshI.H.

◆ state() [1/2]

Foam::LagrangianState state ( const label i ) const

inline

Return the state for an element of the mesh, or a none state.

if not changing

Definition at line 122 of file LagrangianMeshI.H.

References Foam::none.

Referenced by LagrangianMesh::changer::changer().

Here is the caller graph for this function:

◆ state() [2/2]

Foam::LagrangianState state	(	const LagrangianSubMesh &	subMesh,
		const label	subi
	)		const

inline

Return the state for an element of a sub mesh, or a none state.

if not changing

Definition at line 128 of file LagrangianMeshI.H.

References LagrangianSubMesh::start().

Here is the call graph for this function:

◆ subMeshIndex()

Foam::label subMeshIndex ( ) const

inline

Get a sub-mesh index.

Definition at line 138 of file LagrangianMeshI.H.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::labelMax, and Foam::labelMin.

Here is the call graph for this function:

◆ schemes()

const Foam::LagrangianSchemes & schemes ( ) const

Access the schemes.

Definition at line 1209 of file LagrangianMesh.C.

Referenced by CarrierField< scalar >::reset().

Here is the caller graph for this function:

◆ solution()

const Foam::LagrangianSolution & solution ( ) const

Access the solution controls.

Definition at line 1220 of file LagrangianMesh.C.

◆ lookupCurrentFields() [1/4]

HashTable<const GeoField*> lookupCurrentFields ( const bool strict = false ) const

Lookup all current-time fields of the given type.

◆ lookupCurrentFields() [2/4]

HashTable<GeoField*> lookupCurrentFields ( const bool strict = false )

Lookup all current-time fields of the given type.

◆ size() [1/2]

Foam::label size ( ) const

inline

Get the number of elements.

Definition at line 160 of file LagrangianMeshI.H.

References Foam::tracking::coordinates(), and VectorSpace< Form, Cmpt, Ncmpts >::size().

Referenced by LagrangianMesh::changer::changer(), LagrangianMesh::partition(), LagrangianMesh::reset(), LagrangianMesh::subMeshGlobalSizes(), and LagrangianMesh::track().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ globalSize()

Foam::label globalSize ( ) const

inline

Get the global number of elements.

Definition at line 166 of file LagrangianMeshI.H.

References Foam::returnReduce().

Here is the call graph for this function:

◆ size() [2/2]

Foam::label size ( const LagrangianMesh & mesh )

inlinestatic

Return size.

Definition at line 172 of file LagrangianMeshI.H.

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

Here is the call graph for this function:

◆ nStates()

Foam::label nStates ( ) const

inline

Return the number of states.

Definition at line 178 of file LagrangianMeshI.H.

References polyMesh::boundaryMesh(), mesh, Foam::onPatchZero, and UPtrList< T >::size().

Here is the call graph for this function:

◆ nGroups()

Foam::label nGroups ( ) const

inline

Return the number of groups.

Definition at line 186 of file LagrangianMeshI.H.

References polyMesh::boundaryMesh(), mesh, Foam::onPatchZero, and UPtrList< T >::size().

Referenced by LagrangianMesh::changer::changer(), LagrangianMesh::partition(), and LagrangianMesh::subMeshGlobalSizes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stateToGroupi()

Foam::label stateToGroupi ( const LagrangianState state ) const

inline

Convert a state to a group index.

Definition at line 194 of file LagrangianMeshI.H.

References Foam::min(), and Foam::stateToGroup().

Referenced by LagrangianMesh::changer::changer(), and LagrangianMesh::partition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sub()

Foam::LagrangianSubMesh sub ( const LagrangianGroup group ) const

inline

Return a sub-mesh for the given group.

Definition at line 208 of file LagrangianMeshI.H.

References Foam::constant::atomic::group.

Referenced by LagrangianMesh::crossFaces(), cloudFunctionObjectUList::preCrossFaces(), and LagrangianMesh::subMeshGlobalSizes().

Here is the caller graph for this function:

◆ subNone()

Foam::LagrangianSubMesh subNone ( ) const

inline

Return a sub-mesh for no elements.

Definition at line 218 of file LagrangianMeshI.H.

References Foam::none.

◆ subAll()

const Foam::LagrangianSubMesh & subAll ( ) const

inline

Return a sub-mesh for all elements.

Definition at line 224 of file LagrangianMeshI.H.

◆ subIncomplete()

Foam::LagrangianSubMesh subIncomplete ( ) const

inline

Return a sub-mesh for all incomplete elements.

Definition at line 230 of file LagrangianMeshI.H.

References Foam::inInternalMesh, and Foam::none.

◆ subMeshGlobalSizes()

Foam::labelList subMeshGlobalSizes ( ) const

Return the global sizes of all the sub-meshes. A value of -1.

will be set for processor-patch sub-meshes.

Definition at line 1231 of file LagrangianMesh.C.

References LagrangianMesh::boundary(), Foam::complete, forAll, Foam::inInternalMesh, UList< T >::last(), Pstream::listCombineGather(), Pstream::listCombineScatter(), LagrangianBoundaryMesh::mesh(), LagrangianMesh::nGroups(), Foam::onPatchZero, patchi, LagrangianMesh::size(), LagrangianSubMesh::size(), and LagrangianMesh::sub().

Here is the call graph for this function:

◆ position() [1/2]

Foam::tmp< Foam::LagrangianVectorInternalField > position ( ) const

Return the global positions.

Definition at line 1286 of file LagrangianMesh.C.

References Foam::dimLength, forAll, DimensionedField< Type, GeoMesh, PrimitiveField >::New(), LagrangianMesh::positionName, and tmp< T >::ref().

Referenced by LagrangianMesh::locate(), and LagrangianMesh::storePosition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ position() [2/2]

Foam::point position ( const label i ) const

Return the global position of an element.

Definition at line 1306 of file LagrangianMesh.C.

References Foam::tracking::position().

Here is the call graph for this function:

◆ locate() [1/2]

Foam::LagrangianMesh::location locate	(	const point &	position,
		barycentric &	coordinates,
		label &	celli,
		label &	facei,
		label &	faceTrii,
		const scalar	fraction
	)		const

Convert a position into a set of coordinates and a.

corresponding tetrahedron. Return a status flag indicating where the point is relative to the bounds of the mesh.

Definition at line 1317 of file LagrangianMesh.C.

References LagrangianMesh::celli(), polyMesh::cellTree(), LagrangianMesh::coordinates(), remote::elementi, LagrangianMesh::facei(), LagrangianMesh::faceTrii(), LagrangianMesh::inCell, Foam::tracking::locate(), LagrangianMesh::mesh(), UPstream::myProcNo(), LagrangianMesh::onBoundary, LagrangianMesh::outsideMesh, LagrangianMesh::position(), remote::proci, and Foam::reduce().

Here is the call graph for this function:

◆ locate() [2/2]

Foam::List< Foam::LagrangianMesh::location > locate	(	const List< point > &	position,
		List< barycentric > &	coordinates,
		labelList &	celli,
		labelList &	facei,
		labelList &	faceTrii,
		const scalarList &	fraction
	)		const

Convert set of positions into a set of coordinates and a.

corresponding tetrahedron. Return status flags indicating where the points are relative to the bounds of the mesh.

Definition at line 1356 of file LagrangianMesh.C.

References LagrangianMesh::celli(), polyMesh::cellTree(), LagrangianMesh::coordinates(), LagrangianMesh::facei(), LagrangianMesh::faceTrii(), forAll, LagrangianMesh::inCell, Foam::tracking::locate(), LagrangianMesh::mesh(), UPstream::myProcNo(), LagrangianMesh::onBoundary, LagrangianMesh::outsideMesh, LagrangianMesh::position(), and Foam::reduce().

Here is the call graph for this function:

◆ partition() [1/4]

void partition ( )

Partition the mesh such that the groups are contiguous in memory.

Definition at line 1401 of file LagrangianMesh.C.

References LagrangianMesh::bin, LagrangianMesh::boundary(), LagrangianMesh::clearPosition(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::indent(), Foam::Info, LagrangianMesh::nGroups(), LagrangianMesh::partitioningAlgorithm_, patchi, LagrangianMesh::quick, LagrangianMesh::size(), LagrangianMesh::states(), and LagrangianMesh::stateToGroupi().

Referenced by LagrangianMesh::changer::changer(), and LagrangianMesh::remove().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ track()

void track	(	const List< LagrangianState > &	endState,
		const Displacement &	displacement,
		const LagrangianSubScalarField &	deltaFraction,
		LagrangianSubScalarSubField &	fraction
	)

Track the positions along the given displacements.

Definition at line 1495 of file LagrangianMesh.C.

References polyMesh::boundaryMesh(), LagrangianMesh::clearPosition(), remote::elementi, Foam::tracking::faceNormalAndDisplacement(), Tuple2< Type1, Type2 >::first(), forAll, primitiveMesh::isInternalFace(), DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), IOobject::name(), Foam::name(), primitiveMesh::nInternalFaces(), OldTimeField< FieldType >::oldTime(), Foam::onInternalFace, Foam::onPatchZero, nonConformalPolyPatch::origPatch(), patchi, polyBoundaryMesh::patchIndices(), Foam::tracking::position(), remote::proci, nonConformalCyclicPolyPatch::ray(), Tuple2< Type1, Type2 >::second(), LagrangianMesh::size(), LagrangianMesh::states(), Foam::tracking::toFace(), and polyPatch::whichFace().

Here is the call graph for this function:

◆ crossFaces()

void crossFaces ( const LagrangianScalarInternalDynamicField & fraction )

Cross the faces.

Definition at line 1640 of file LagrangianMesh.C.

References UPstream::blocking, LagrangianMesh::boundary(), LagrangianMesh::clearPosition(), UPstream::commsTypeNames, Foam::tracking::crossInternalFace(), UPstream::defaultCommsType, EVAL_TYPE_PATCH_FIELDS, Foam::exit(), Foam::FatalError, FatalErrorInFunction, PstreamBuffers::finishedSends(), Foam::FOR_ALL_FIELD_TYPES(), forAll, Foam::inCell, Foam::inInternalMesh, INIT_EVAL_TYPE_PATCH_FIELDS, UPstream::nonBlocking, Foam::onInternalFace, patchi, LagrangianSubMesh::start(), LagrangianMesh::states(), and LagrangianMesh::sub().

Here is the call graph for this function:

◆ inject() [1/4]

LagrangianSubMesh inject	(	const barycentricField &	coordinates,
		const labelField &	celli,
		const labelField &	facei,
		const labelField &	faceTrii,
		const FieldNamesAndFields &...	fieldNamesAndFields
	)

Inject specified elements into the mesh. This method does not.

know how to set values for the fields. If any fields are registered then this function will error.

Referenced by LagrangianFieldReconstructor::LagrangianFieldReconstructor().

Here is the caller graph for this function:

◆ inject() [2/4]

LagrangianSubMesh inject	(	const LagrangianInjection &	injection,
		const barycentricField &	coordinates,
		const labelField &	celli,
		const labelField &	facei,
		const labelField &	faceTrii,
		const FieldNamesAndFields &...	fieldNamesAndFields
	)

Inject specified elements into the mesh. Fields are expanded.

accordingly. New field values can be specified manually by providing alternating name and field arguments. Source conditions will be used to set values for all other fields. Internal fields without source conditions must be specified manually or an error will result.

◆ birth() [1/2]

LagrangianSubMesh birth	(	const labelList &	parents,
		const FieldNamesAndFields &...	fieldNamesAndFields
	)

Birth specified elements into the mesh. Fields are expanded.

accordingly. New field values can be specified manually by providing alternating name and field arguments. Values for other fields will be mapped from the parent elements.

◆ reset()

void reset	(	const bool	initial,
		const bool	final
	)

Reset the mesh to the old-time conditions.

Definition at line 1756 of file LagrangianMesh.C.

References CLEAR_OLD_TIME_TYPE_FIELDS, OldTimeField< FieldType >::clearOldTimes(), LagrangianMesh::clearPosition(), UList< T >::empty(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, fieldNames, Foam::FOR_ALL_FIELD_TYPES(), INSERT_FIELD_NAMES, OLD_TIME_TYPE_FIELDS, OldTimeField< FieldType >::oldTime(), RESET_OLD_TIME_TYPE_FIELDS, LagrangianMesh::size(), and OldTimeField< FieldType >::storeOldTimes().

Here is the call graph for this function:

◆ clear()

void clear ( )

Clear all geometry out of the Lagrangian mesh.

Definition at line 1864 of file LagrangianMesh.C.

References LagrangianMesh::clearPosition(), and LagrangianMesh::states().

Here is the call graph for this function:

◆ partition() [2/4]

Foam::labelList partition	(	const label	nGroups,
		const UList< labelPair > &	elementsGroups
	)

Manually partition a sub-set of the mesh given a list of.

element-group pairs. Elements not given a group will remain in a block at the start of the mesh. Elements with multiple groups will be placed in the block associated with the group with the largest index. Return offsets to the blocks.

Definition at line 1882 of file LagrangianMesh.C.

References UList< T >::empty(), LagrangianMesh::nGroups(), NotImplemented, and LagrangianMesh::size().

Here is the call graph for this function:

◆ partition() [3/4]

labelList partition	(	const label	nGroups,
		const UList< elementGroup< Enumeration >> &	elementsGroups
	)

As above but for enumerated groups.

◆ remove() [1/2]

void remove ( const UList< label > & elements )

Remove specified elements from the mesh. Shuffles everything.

else up.

Definition at line 1899 of file LagrangianMesh.C.

References forAll, LagrangianMesh::partition(), and UList< T >::size().

Here is the call graph for this function:

◆ remove() [2/2]

void remove ( const label nElements )

Remove a specified number of elements from the end of the mesh.

Definition at line 1913 of file LagrangianMesh.C.

References NotImplemented.

◆ clearPosition()

void clearPosition ( )

virtual

Clear the positions uses during mapping.

Definition at line 1925 of file LagrangianMesh.C.

References LagrangianMesh::positionName.

Referenced by LagrangianMesh::clear(), LagrangianMesh::crossFaces(), LagrangianMesh::partition(), LagrangianMesh::reset(), and LagrangianMesh::track().

Here is the caller graph for this function:

◆ storePosition()

void storePosition ( )

virtual

Store the positions for use during mapping.

Definition at line 1934 of file LagrangianMesh.C.

References LagrangianMesh::position(), and LagrangianMesh::positionName.

Here is the call graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Definition at line 1943 of file LagrangianMesh.C.

References UList< T >::empty(), NotImplemented, and polyTopoChangeMap::reverseCellMap().

Here is the call graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Definition at line 1953 of file LagrangianMesh.C.

References NotImplemented.

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Definition at line 1961 of file LagrangianMesh.C.

References NotImplemented.

◆ writeObject()

bool writeObject	(	IOstream::streamFormat	fmt,
		IOstream::versionNumber	ver,
		IOstream::compressionType	cmp,
		const bool	write = `true`
	)		const

virtual

Write using given format, version and compression.

Reimplemented from objectRegistry.

Definition at line 1969 of file LagrangianMesh.C.

References LagrangianMesh::write(), and objectRegistry::writeObject().

Here is the call graph for this function:

◆ write()

bool write ( const bool write = true ) const

virtual

Write settings from the database.

Reimplemented from regIOobject.

Definition at line 1981 of file LagrangianMesh.C.

References regIOobject::write().

Referenced by LagrangianMesh::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const LagrangianMesh & )

delete

Disallow default bitwise assignment.

◆ appendSpecifiedFields()

Foam::wordHashSet appendSpecifiedFields	(	const LagrangianSubMesh &	appendMesh,
		const word &	fieldName,
		const Field< Type > &	field,
		const FieldNamesAndFields &...	fieldNamesAndFields
	)		const

Definition at line 71 of file LagrangianMeshTemplates.C.

References List< T >::append(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, fieldNames, found, HashSet< Key, Hash >::insert(), Foam::nl, Foam::sort(), and TypeName.

Here is the call graph for this function:

◆ lookupCurrentFields() [3/4]

Foam::HashTable<const GeoField*> lookupCurrentFields ( const bool strict ) const

Definition at line 139 of file LagrangianMeshTemplates.C.

References fields, and forAllIter.

◆ lookupCurrentFields() [4/4]

Foam::HashTable<GeoField*> lookupCurrentFields ( const bool strict )

Definition at line 157 of file LagrangianMeshTemplates.C.

References fields, and forAllIter.

◆ inject() [3/4]

Foam::LagrangianSubMesh inject	(	const barycentricField &	coordinates,
		const labelField &	celli,
		const labelField &	facei,
		const labelField &	faceTrii,
		const FieldNamesAndFields &...	fieldNamesAndFields
	)

Definition at line 174 of file LagrangianMeshTemplates.C.

References Foam::tracking::coordinates().

Here is the call graph for this function:

◆ inject() [4/4]

Foam::LagrangianSubMesh inject	(	const LagrangianInjection &	injection,
		const barycentricField &	coordinates,
		const labelField &	celli,
		const labelField &	facei,
		const labelField &	faceTrii,
		const FieldNamesAndFields &...	fieldNamesAndFields
	)

Definition at line 196 of file LagrangianMeshTemplates.C.

References Foam::tracking::coordinates().

Here is the call graph for this function:

◆ birth() [2/2]

Foam::LagrangianSubMesh birth	(	const labelList &	parents,
		const FieldNamesAndFields &...	fieldNamesAndFields
	)

Definition at line 219 of file LagrangianMeshTemplates.C.

◆ partition() [4/4]

Foam::labelList partition	(	const label	nGroups,
		const UList< elementGroup< Enumeration >> &	elementsGroups
	)

Definition at line 237 of file LagrangianMeshTemplates.C.

◆ time()

const Time& time

inline

Return time.

Definition at line 147 of file objectRegistry.H.

Referenced by LagrangianMesh::LagrangianMesh(), LagrangianSubMesh::Uf(), and totalPressureVelocityLagrangianVectorFieldSource::value().

Here is the caller graph for this function:

◆ thisDb()

const objectRegistry& thisDb

inline

Return the object registry.

Definition at line 236 of file objectRegistry.H.

Friends And Related Function Documentation

◆ nonConformalCyclicLagrangianPatch

friend class nonConformalCyclicLagrangianPatch

friend

The non-conformal cyclic patch needs to access the receiving.

information populated during tracking

Definition at line 327 of file LagrangianMesh.H.

◆ processorLagrangianPatch

friend class processorLagrangianPatch

friend

The processor patch communicates and adds elements to the receiving.

side, but field values are added later by the corresponding patch field. This is not permitted by the public interface in which elements and associated field values are required to be added simultaneously so that they are guaranteed to remain consistent. The requirements of the processor patch and patch fields are considered a special case, so access to the private append methods is permitted to these classes.

Definition at line 337 of file LagrangianMesh.H.

◆ processorLagrangianPatchField

friend class processorLagrangianPatchField

friend

See above.

Definition at line 341 of file LagrangianMesh.H.

◆ nonConformalProcessorCyclicLagrangianPatch

friend class nonConformalProcessorCyclicLagrangianPatch

friend

See above.

Definition at line 344 of file LagrangianMesh.H.

◆ nonConformalProcessorCyclicLagrangianPatchField

friend class nonConformalProcessorCyclicLagrangianPatchField

friend

See above.

Definition at line 348 of file LagrangianMesh.H.

Member Data Documentation

◆ permutationAlgorithmNames_

const NamedEnum< LagrangianMesh::permutationAlgorithm, 2 > permutationAlgorithmNames_ {"copy", "inPlace"}

static

Permutation algorithm names.

Definition at line 82 of file LagrangianMesh.H.

◆ partitioningAlgorithmNames_

const NamedEnum< LagrangianMesh::partitioningAlgorithm, 2 > partitioningAlgorithmNames_ {"bin", "quick"}

static

Partitioning algorithm names.

Definition at line 93 of file LagrangianMesh.H.

◆ prefix

const word prefix

static

Instance prefix.

Definition at line 530 of file LagrangianMesh.H.

◆ coordinatesName

const word coordinatesName

static

Name of the coordinates field.

Definition at line 533 of file LagrangianMesh.H.

◆ positionName

const word positionName

static

Name of the position field.

Definition at line 536 of file LagrangianMesh.H.

Referenced by LagrangianMesh::clearPosition(), LagrangianMesh::position(), and LagrangianMesh::storePosition().

◆ stateName

const word stateName

static

Name of the state field.

Definition at line 539 of file LagrangianMesh.H.

◆ fractionName

const word fractionName

static

Name of the tracked fraction field.

Definition at line 542 of file LagrangianMesh.H.

Referenced by diskInjection::modify(), manualInjection::modify(), patchInjection::modify(), pointInjection::modify(), volumeInjection::modify(), cloud::solve(), and Function1LagrangianFieldSource< Type >::value().

◆ permutationAlgorithm_

LagrangianMesh::permutationAlgorithm permutationAlgorithm_

static

Initial value:

=
        Foam::debug::namedEnumOptimisationSwitch
        (
            (LagrangianMesh::typeName + "Permutation").c_str(),
            LagrangianMesh::permutationAlgorithmNames_,
            LagrangianMesh::permutationAlgorithm::copy
        )

Permutation algorithm.

Definition at line 545 of file LagrangianMesh.H.

◆ partitioningAlgorithm_

LagrangianMesh::partitioningAlgorithm partitioningAlgorithm_

static

Initial value:

=
        Foam::debug::namedEnumOptimisationSwitch
        (
            (LagrangianMesh::typeName + "Partitioning").c_str(),
            LagrangianMesh::partitioningAlgorithmNames_,
            LagrangianMesh::partitioningAlgorithm::bin
        )

Partitioning algorithm.

Definition at line 548 of file LagrangianMesh.H.

Referenced by LagrangianMesh::partition().

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

src/Lagrangian/Lagrangian/LagrangianMesh/LagrangianMesh.H
src/Lagrangian/Lagrangian/LagrangianMesh/LagrangianMesh.C
src/Lagrangian/Lagrangian/LagrangianMesh/LagrangianMeshI.H
src/Lagrangian/Lagrangian/LagrangianMesh/LagrangianMeshTemplates.C

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Mesh

◆ BoundaryMesh

◆ PatchField

◆ FieldSource

Member Enumeration Documentation

◆ permutationAlgorithm

◆ partitioningAlgorithm

◆ location

Constructor & Destructor Documentation

◆ LagrangianMesh() [1/3]

◆ LagrangianMesh() [2/3]

◆ LagrangianMesh() [3/3]

◆ ~LagrangianMesh()

Member Function Documentation

◆ ClassName()

◆ mesh()

◆ coordinates()

◆ celli()

◆ facei()

◆ faceTrii()

◆ boundary()

◆ changing()

◆ states() [1/2]

◆ states() [2/2]

◆ state() [1/2]

◆ state() [2/2]

◆ subMeshIndex()

◆ schemes()

◆ solution()

◆ lookupCurrentFields() [1/4]

◆ lookupCurrentFields() [2/4]

◆ size() [1/2]

◆ globalSize()

◆ size() [2/2]

◆ nStates()

◆ nGroups()

◆ stateToGroupi()

◆ sub()

◆ subNone()

◆ subAll()

◆ subIncomplete()

◆ subMeshGlobalSizes()

◆ position() [1/2]

◆ position() [2/2]

◆ locate() [1/2]

◆ locate() [2/2]

◆ partition() [1/4]

◆ track()

◆ crossFaces()

◆ inject() [1/4]

◆ inject() [2/4]

◆ birth() [1/2]

◆ reset()

◆ clear()

◆ partition() [2/4]

◆ partition() [3/4]

◆ remove() [1/2]

◆ remove() [2/2]

◆ clearPosition()

◆ storePosition()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ writeObject()

◆ write()

◆ operator=()

◆ appendSpecifiedFields()

◆ lookupCurrentFields() [3/4]

◆ lookupCurrentFields() [4/4]

◆ inject() [3/4]

◆ inject() [4/4]