Executes primitiveMesh::checkMesh(true) every execute time for which the mesh changed, i.e. moved or changed topology. More...

Inheritance diagram for checkMesh:

[legend]

Collaboration diagram for checkMesh:

[legend]

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

	checkMesh (const word &name, const Time &, const dictionary &)
	Construct from Time and dictionary. More...

virtual	~checkMesh ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read the checkMesh controls. More...

virtual wordList	fields () const
	Return the list of fields required. More...

virtual bool	execute ()
	Execute primitiveMesh::checkMesh(true) More...

virtual bool	write ()
	Do nothing. More...

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

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

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

virtual	~fvMeshFunctionObject ()
	Destructor. More...

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

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

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

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

virtual	~regionFunctionObject ()
	Destructor. More...

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

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const Time &runTime)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

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

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. More...

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual scalar	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

virtual void	movePoints (const polyMesh &mesh)
	Update topology using the given map. More...

virtual void	topoChange (const polyTopoChangeMap &map)
	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...

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

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch write log to Info. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Protected Member Functions inherited from fvMeshFunctionObject
labelHashSet	patchSet (const dictionary &, const bool optional=false) const
	Return the patch set corresponding to the patch selection entries. More...

Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObjects (const wordList &fieldNames)
	Prints a warning message that fieldNames cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
bool	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
bool	store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the objectRegistry if present. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

Detailed Description

Executes primitiveMesh::checkMesh(true) every execute time for which the mesh changed, i.e. moved or changed topology.

Useful to check the correctness of changing and morphing meshes.

Usage

Property	Description	Required	Default value
`type`	type name: checkMesh	yes
`noTopology`	Skip checking the mesh topology	no	false
`allTopology`	Check all addressing	no	false
`allGeometry`	Check all geometry	no	false
`writeSurfaces`	Reconstruct and write problem faces	no	false
`surfaceFormat`	Format for problem faceSets	no	vtk
`writeSets`	Reconstruct and write problem points	no	false
`setFormat`	Format used to write the problem pointSets	no	vtk
`nonOrthThreshold`	Threshold for non-orthogonality errors	no	70 deg
`skewThreshold`	Threshold for reporting skewness errors	no	4
`stopAt`	Stops the run if any mesh checks fail	no	endTime

The optional stopAt option may be set to

endTime : Continue running on error
noWriteNow : Stops the run on error without write
writeNow : Stops the run on error and writes fields
nextWrite : Stops the run at the next write time on error

Example of checkMesh specification:

    checkMesh
    {
        type            checkMesh;
        libs            ("libutilityFunctionObjects.so");

        executeControl  timeStep;
        executeInterval 10;

        allGeometry     true;
        allTopology     true;

        writeSurfaces   true;
        surfaceFormat   vtk;

        writeSets       true;
        setFormat       vtk;

        stopAt          writeNow;
    }

or using the standard configuration file:

    #includeFunc checkMesh(executeInterval=10, allGeometry=true)

Source files

Definition at line 165 of file checkMesh.H.

Constructor & Destructor Documentation

◆ checkMesh()

checkMesh	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 47 of file checkMesh.C.

References dict, and checkMesh::read().

Here is the call graph for this function:

◆ ~checkMesh()

~checkMesh ( )

virtual

Destructor.

Definition at line 63 of file checkMesh.C.

Member Function Documentation

◆ TypeName()

TypeName ( "checkMesh" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the checkMesh controls.

Reimplemented from regionFunctionObject.

Definition at line 69 of file checkMesh.C.

References Foam::degToRad(), dict, Time::endTime, functionObject::read(), Time::stopAtControlNames, and Foam::unitDegrees.

Referenced by checkMesh::checkMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fields()

virtual wordList fields ( ) const

inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 214 of file checkMesh.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Execute primitiveMesh::checkMesh(true)

Implements functionObject.

Definition at line 112 of file checkMesh.C.

References Foam::meshCheck::checkGeometry(), Foam::meshCheck::checkTopology(), Foam::endl(), Time::endTime, Foam::Info, surfaceWriter::New(), setWriter::New(), and Time::stopAtControlNames.

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Do nothing.

Implements functionObject.

Definition at line 189 of file checkMesh.C.

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

src/functionObjects/utilities/checkMesh/checkMesh.H
src/functionObjects/utilities/checkMesh/checkMesh.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ checkMesh()

◆ ~checkMesh()

Member Function Documentation

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()