Application of (multi-)patch point constraints. More...

Inheritance diagram for pointConstraints:

Collaboration diagram for pointConstraints:

Public Member Functions
	ClassName ("pointConstraints")

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

	~pointConstraints ()
	Destructor. More...

const labelList &	patchPatchPointConstraintPoints () const
	Mesh points on which to apply special constraints. More...

const tensorField &	patchPatchPointConstraintTensors () const
	Special constraints. More...

const List< pointConstraint > &	patchPatchPointConstraints () const
	Actual constraints. More...

virtual bool	movePoints ()
	Correct weighting factors for moving mesh. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update mesh topology using the morph engine. More...

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

virtual void	distribute (const polyDistributionMap &)
	Update corresponding to the given distribution map. More...

template<class Type >
void	constrainCorners (PointField< Type > &pf) const
	Apply patch-patch constraints only. More...

template<class Type >
void	constrain (PointField< Type > &pf, const bool overrideValue=false) const
	Apply boundary conditions (single-patch constraints) and. More...

void	constrainDisplacement (pointVectorField &displacement, const bool overrideValue=false) const
	Apply boundary conditions (single-patch constraints),. More...

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

template<>
void	constrainCorners (PointField< scalar > &pf) const

template<>
void	constrainCorners (PointField< label > &pf) const

Public Member Functions inherited from DemandDrivenMeshObject< pointMesh, TopoChangeableMeshObject, pointConstraints >
virtual const word &	type () const
	Runtime type information. More...

virtual	~DemandDrivenMeshObject ()

const pointMesh &	mesh () const

virtual bool	writeData (Foam::Ostream &) const
	Pure virtual writaData function. 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 (const 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...

virtual void	rename (const word &newName)
	Rename. 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...

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

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

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

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	dependenciesModified () const
	Return true if the object's dependencies have been modified. More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

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

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

void	operator= (const IOobject &)
	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 word &typeName, 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...

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 word &typeName, 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 TopoChangeableMeshObject< Mesh >
template<class Type >
	TopoChangeableMeshObject (Type &mo)

Public Member Functions inherited from DistributeableMeshObject< Mesh >
template<class Type >
	DistributeableMeshObject (Type &mo)

Public Member Functions inherited from MoveableMeshObject< Mesh >
template<class Type >
	MoveableMeshObject (Type &mo)

Public Member Functions inherited from DeletableMeshObject< Mesh >
template<class Type >
	DeletableMeshObject (Type &mo)

virtual	~DeletableMeshObject ()=default
	Virtual destructor to make class polymorphic. More...

Static Public Member Functions
template<class Type , class CombineOp >
static void	syncUntransformedData (const polyMesh &mesh, List< Type > &pointData, const CombineOp &cop)
	Helper: sync data on collocated points only. More...

template<class Type >
static void	setPatchFields (PointField< Type > &)
	Helper: set patchField values from internal values (on. More...

Static Public Member Functions inherited from DemandDrivenMeshObject< pointMesh, TopoChangeableMeshObject, pointConstraints >
static pointConstraints &	New (const word &name, const pointMesh &mesh)
	Construct and return the named DemandDrivenMeshObject. More...

static pointConstraints &	New (const pointMesh &mesh)
	Construct and return the DemandDrivenMeshObject named Type::typeName. More...

static pointConstraints &	New (const word &name, const pointMesh &mesh, const Args &... args)
	Construct and return the named DemandDrivenMeshObject. More...

static pointConstraints &	New (const pointMesh &mesh, const Args &... args)
	Construct and return the DemandDrivenMeshObject named Type::typeName. More...

static bool	found (const word &name, const pointMesh &mesh)
	Return true if the DemandDrivenMeshObject with the given name. More...

static bool	found (const pointMesh &mesh)
	Return true if the DemandDrivenMeshObject named Type::typeName. 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...

Protected Member Functions
	pointConstraints (const pointMesh &)
	Constructor from pointMesh. More...

Protected Member Functions inherited from DemandDrivenMeshObject< pointMesh, TopoChangeableMeshObject, pointConstraints >
	DemandDrivenMeshObject (const IOobject &io, const pointMesh &mesh)
	Construct from mesh and IOobject. More...

	DemandDrivenMeshObject (const word &name, const pointMesh &mesh)
	Construct from mesh and name. More...

	DemandDrivenMeshObject (const pointMesh &mesh)
	Construct from mesh, the name is set to Type::typeName. More...

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
void	setBad (const string &)
	Set the object state to bad. More...

template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Friends
class	DemandDrivenMeshObject< pointMesh, TopoChangeableMeshObject, pointConstraints >

Additional Inherited Members
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...

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

Detailed Description

Application of (multi-)patch point constraints.

Note: includes all points which are on the boundary of a patch with a constraint. It includes them (even though the constraint will already be implemented through the patch evaluation) since these points might be coupled to points which are not on any constraint patch and we don't want to get inconsistency between the two points.

Source files

Definition at line 61 of file pointConstraints.H.

Constructor & Destructor Documentation

◆ pointConstraints() [1/2]

pointConstraints ( const pointMesh & pm )

explicitprotected

Constructor from pointMesh.

Definition at line 334 of file pointConstraints.C.

References Foam::endl(), IOobject::name(), and Foam::Pout.

Here is the call graph for this function:

◆ pointConstraints() [2/2]

pointConstraints ( const pointConstraints & )

delete

Disallow default bitwise copy construction.

◆ ~pointConstraints()

~pointConstraints ( )

Destructor.

Definition at line 356 of file pointConstraints.C.

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

Here is the call graph for this function:

Member Function Documentation

◆ ClassName()

ClassName ( "pointConstraints" )

◆ patchPatchPointConstraintPoints()

const labelList& patchPatchPointConstraintPoints ( ) const

inline

Mesh points on which to apply special constraints.

Definition at line 124 of file pointConstraints.H.

◆ patchPatchPointConstraintTensors()

const tensorField& patchPatchPointConstraintTensors ( ) const

inline

Special constraints.

Definition at line 130 of file pointConstraints.H.

◆ patchPatchPointConstraints()

const List<pointConstraint>& patchPatchPointConstraints ( ) const

inline

Actual constraints.

Definition at line 136 of file pointConstraints.H.

◆ movePoints()

bool movePoints ( )

virtual

Correct weighting factors for moving mesh.

Implements MoveableMeshObject< Mesh >.

Definition at line 367 of file pointConstraints.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & )

virtual

Update mesh topology using the morph engine.

Implements TopoChangeableMeshObject< Mesh >.

Definition at line 373 of file pointConstraints.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & )

virtual

Update from another mesh using the given map.

Implements TopoChangeableMeshObject< Mesh >.

Definition at line 379 of file pointConstraints.C.

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Update corresponding to the given distribution map.

Implements DistributeableMeshObject< Mesh >.

Definition at line 385 of file pointConstraints.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ syncUntransformedData()

void syncUntransformedData	(	const polyMesh &	mesh,
		List< Type > &	pointData,
		const CombineOp &	cop
	)

static

Helper: sync data on collocated points only.

Definition at line 33 of file pointConstraintsTemplates.C.

References distributionMapBase::constructSize(), globalMeshData::coupledPatch(), distributionMap::distribute(), forAll, globalMeshData::globalCoPointSlaves(), globalMeshData::globalCoPointSlavesMap(), pointMesh::globalData(), DemandDrivenMeshObject< pointMesh, TopoChangeableMeshObject, pointConstraints >::mesh(), PrimitivePatch< FaceList, PointField >::meshPoints(), distributionMap::reverseDistribute(), and List< T >::size().

Here is the call graph for this function:

◆ setPatchFields()

void setPatchFields ( PointField< Type > & pf )

static

Helper: set patchField values from internal values (on.

valuePointPatchFields). Opposite of pointPatchField::setInternalField

Definition at line 89 of file pointConstraintsTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), forAll, Foam::isA(), patchi, and pointPatchField< Type >::patchInternalField().

Here is the call graph for this function:

◆ constrainCorners() [1/3]

void constrainCorners ( PointField< Type > & pf ) const

Apply patch-patch constraints only.

Definition at line 111 of file pointConstraintsTemplates.C.

References forAll, and Foam::transform().

Referenced by motionSmootherAlgo::correctBoundaryConditions(), and motionSmootherAlgo::setDisplacementPatchFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ constrain()

void constrain	(	PointField< Type > &	pf,
		const bool	overrideValue = `false`
	)		const

Apply boundary conditions (single-patch constraints) and.

patch-patch constraints on generic pointField. Optionally override valuePointPatchFields with constrained values (see setPatchFields above)

Definition at line 128 of file pointConstraintsTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), and GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef().

Referenced by motionSmootherAlgo::avg(), multiValveEngine::movingObject::calcScale(), rigidBodyMeshMotion::rigidBodyMeshMotion(), sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver(), motionSmootherAlgo::smooth(), and rigidBodyMeshMotion::topoChange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ constrainDisplacement()

void constrainDisplacement	(	pointVectorField &	displacement,
		const bool	overrideValue = `false`
	)		const

Apply boundary conditions (single-patch constraints),.

patch-patch constraints and two-D constraints on displacement field

Definition at line 392 of file pointConstraints.C.

References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), twoDPointCorrector::correctDisplacement(), DimensionedField< Type, GeoMesh >::mesh(), DemandDrivenMeshObject< polyMesh, TopoChangeableMeshObject, twoDPointCorrector >::New(), points, and GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef().

Referenced by volPointInterpolation::interpolateDisplacement(), displacementLayeredMotionMotionSolver::solve(), rigidBodyMeshMotion::solve(), and sixDoFRigidBodyMotionSolver::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const pointConstraints & )

delete

Disallow default bitwise assignment.

◆ constrainCorners() [2/3]

void constrainCorners ( PointField< scalar > & pf ) const

◆ constrainCorners() [3/3]

void constrainCorners ( PointField< label > & pf ) const

Friends And Related Function Documentation

◆ DemandDrivenMeshObject< pointMesh, TopoChangeableMeshObject, pointConstraints >

friend class DemandDrivenMeshObject< pointMesh, TopoChangeableMeshObject, pointConstraints >

friend

Definition at line 85 of file pointConstraints.H.

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

src/finiteVolume/interpolation/volPointInterpolation/pointConstraints.H
src/finiteVolume/interpolation/volPointInterpolation/pointConstraints.C
src/finiteVolume/interpolation/volPointInterpolation/pointConstraintsTemplates.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pointConstraints() [1/2]

◆ pointConstraints() [2/2]

◆ ~pointConstraints()

Member Function Documentation

◆ ClassName()

◆ patchPatchPointConstraintPoints()

◆ patchPatchPointConstraintTensors()

◆ patchPatchPointConstraints()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ syncUntransformedData()

◆ setPatchFields()

◆ constrainCorners() [1/3]

◆ constrain()

◆ constrainDisplacement()

◆ operator=()

◆ constrainCorners() [2/3]

◆ constrainCorners() [3/3]

Friends And Related Function Documentation

◆ DemandDrivenMeshObject< pointMesh, TopoChangeableMeshObject, pointConstraints >