Given a displacement moves the mesh by scaling the displacement back until there are no more mesh errors. More...

Inheritance diagram for motionSmootherAlgo:

Public Member Functions
	ClassName ("motionSmootherAlgo")

	motionSmootherAlgo (polyMesh &, pointMesh &, indirectPrimitivePatch &pp, pointVectorField &displacement, pointScalarField &scale, pointField &oldPoints, const labelList &adaptPatchIDs, const dictionary &paramDict, const bool dryRun=false)
	Construct from mesh, patches to work on and smoothing parameters. More...

	~motionSmootherAlgo ()
	Destructor. More...

const polyMesh &	mesh () const
	Reference to mesh. More...

const pointMesh &	pMesh () const
	Reference to pointMesh. More...

const indirectPrimitivePatch &	patch () const
	Reference to patch. More...

const labelList &	adaptPatchIDs () const
	Patch labels that are being adapted. More...

const dictionary &	paramDict () const

pointVectorField &	pointDisplacement ()
	Return reference to the point motion displacement field. More...

const pointVectorField &	pointDisplacement () const
	Return const reference to the point motion displacement field. More...

void	correct ()
	Take over existing mesh position. More...

void	setDisplacementPatchFields ()
	Set patch fields on displacement to be consistent with. More...

void	setDisplacement (pointField &patchDisp)

void	correctBoundaryConditions (pointVectorField &) const
	Special correctBoundaryConditions which evaluates fixedValue. More...

void	modifyMotionPoints (pointField &newPoints) const
	Apply optional point constraint (2d correction) More...

tmp< pointField >	curPoints () const
	Get the current points (oldPoints+scale*displacement) More...

scalar	setErrorReduction (const scalar)
	Set the errorReduction (by how much to scale the displacement. More...

bool	scaleMesh (labelList &checkFaces, const bool smoothMesh=true, const label nAllow=0)
	Move mesh with given scale. Return true if mesh ok or has. More...

bool	scaleMesh (labelList &checkFaces, const List< labelPair > &baffles, const bool smoothMesh=true, const label nAllow=0)
	Move mesh (with baffles) with given scale. More...

bool	scaleMesh (labelList &checkFaces, const List< labelPair > &baffles, const dictionary &paramDict, const dictionary &meshQualityDict, const bool smoothMesh=true, const label nAllow=0)
	Move mesh with externally provided mesh constraints. More...

void	movePoints ()
	Update for new mesh geometry. More...

void	updateMesh ()
	Update for new mesh topology. More...

template<class Type >
void	smooth (const GeometricField< Type, pointPatchField, pointMesh > &fld, const scalarField &edgeWeight, GeometricField< Type, pointPatchField, pointMesh > &newFld) const
	Fully explicit smoothing of fields (not positions) More...

template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::pointPatchField, Foam::pointMesh > >	avg (const GeometricField< Type, pointPatchField, pointMesh > &fld, const scalarField &edgeWeight) const

Static Public Member Functions
static void	setDisplacementPatchFields (const labelList &patchIDs, pointVectorField &pointDisplacement)
	Set patch fields on patchIDs to be consistent with. More...

static void	setDisplacement (const labelList &patchIDs, const indirectPrimitivePatch &pp, pointField &patchDisp, pointVectorField &displacement)
	Set displacement field from displacement on patch points. More...

static bool	checkMesh (const bool report, const polyMesh &mesh, const dictionary &dict, labelHashSet &wrongFaces, const bool dryRun=false)
	Check mesh with mesh settings in dict. Collects incorrect faces. More...

static bool	checkMesh (const bool report, const polyMesh &mesh, const dictionary &dict, const labelList &checkFaces, labelHashSet &wrongFaces, const bool dryRun=false)
	Check (subset of mesh) with mesh settings in dict. More...

static bool	checkMesh (const bool report, const polyMesh &mesh, const dictionary &dict, const labelList &checkFaces, const List< labelPair > &baffles, labelHashSet &wrongFaces, const bool dryRun=false)
	Check (subset of mesh including baffles) with mesh settings. More...

static bool	checkMesh (const bool report, const dictionary &dict, const polyMeshGeometry &, const pointField &, const labelList &checkFaces, labelHashSet &wrongFaces, const bool dryRun=false)
	Check part of mesh with mesh settings in dict. More...

static bool	checkMesh (const bool report, const dictionary &dict, const polyMeshGeometry &, const pointField &, const labelList &checkFaces, const List< labelPair > &baffles, labelHashSet &wrongFaces, const bool dryRun=false)
	Check part of mesh including baffles with mesh settings in dict. More...

template<class Type >
static Type	get (const dictionary &dict, const word &keyword, const bool noExit, enum keyType::option matchOpt, const Type &defaultValue=Zero)
	Wrapper around dictionary::get which does not exit. More...

Detailed Description

Given a displacement moves the mesh by scaling the displacement back until there are no more mesh errors.

Holds displacement field (read upon construction since need boundary conditions) and scaling factor and optional patch number on which to scale back displacement.

E.g.

    // Construct iterative mesh mover.
    motionSmoother meshMover(mesh, labelList(1, patchi));

    // Set desired displacement:
    meshMover.displacement() = ..

    for (label iter = 0; iter < maxIter; iter++)
    {
        if (meshMover.scaleMesh(true))
        {
            Info<< "Successfully moved mesh" << endl;
            return true;
        }
    }

Note

Shared points (parallel): a processor can have points which are part of pp on another processor but have no pp itself (i.e. it has points and/or edges but no faces of pp). Hence we have to be careful when e.g. synchronising displacements that the value from the processor which has faces of pp get priority. This is currently handled in setDisplacement by resetting the internal displacement to zero on coupled points that are coupled to patch points before doing anything else. The combine operator used will give preference to non-zero values.
Various routines take baffles. These are sets of boundary faces that are treated as a single internal face. This is a hack used to apply movement to internal faces.
Mesh constraints are looked up from the supplied dictionary. (uses recursive lookup)

Source files

Definition at line 96 of file motionSmootherAlgo.H.

Constructor & Destructor Documentation

◆ motionSmootherAlgo()

motionSmootherAlgo	(	polyMesh &	mesh,
		pointMesh &	pMesh,
		indirectPrimitivePatch &	pp,
		pointVectorField &	displacement,
		pointScalarField &	scale,
		pointField &	oldPoints,
		const labelList &	adaptPatchIDs,
		const dictionary &	paramDict,
		const bool	dryRun = `false`
	)

Construct from mesh, patches to work on and smoothing parameters.

Definition at line 319 of file motionSmootherAlgo.C.

◆ ~motionSmootherAlgo()

~motionSmootherAlgo ( )

Destructor.

Definition at line 348 of file motionSmootherAlgo.C.

Member Function Documentation

◆ ClassName()

ClassName ( "motionSmootherAlgo" )

◆ mesh()

const Foam::polyMesh & mesh ( ) const

Reference to mesh.

Definition at line 354 of file motionSmootherAlgo.C.

◆ pMesh()

const Foam::pointMesh & pMesh ( ) const

Reference to pointMesh.

Definition at line 360 of file motionSmootherAlgo.C.

Referenced by snappySnapDriver::smoothDisplacement().

Here is the caller graph for this function:

◆ patch()

const Foam::indirectPrimitivePatch & patch ( ) const

Reference to patch.

Definition at line 366 of file motionSmootherAlgo.C.

Referenced by snappySnapDriver::smoothDisplacement().

Here is the caller graph for this function:

◆ adaptPatchIDs()

const Foam::labelList & adaptPatchIDs ( ) const

Patch labels that are being adapted.

Definition at line 372 of file motionSmootherAlgo.C.

◆ paramDict()

const Foam::dictionary & paramDict ( ) const

Definition at line 378 of file motionSmootherAlgo.C.

◆ pointDisplacement() [1/2]

pointVectorField& pointDisplacement ( )

inline

Return reference to the point motion displacement field.

Definition at line 411 of file motionSmootherAlgo.H.

Referenced by snappySnapDriver::preSmoothPatch().

Here is the caller graph for this function:

◆ pointDisplacement() [2/2]

const pointVectorField& pointDisplacement ( ) const

inline

Return const reference to the point motion displacement field.

Definition at line 419 of file motionSmootherAlgo.H.

◆ correct()

void correct ( )

Take over existing mesh position.

Definition at line 384 of file motionSmootherAlgo.C.

Referenced by snappySnapDriver::doSnap(), and snappySnapDriver::preSmoothPatch().

Here is the caller graph for this function:

◆ setDisplacementPatchFields() [1/2]

void setDisplacementPatchFields	(	const labelList &	patchIDs,
		pointVectorField &	pointDisplacement
	)

static

Set patch fields on patchIDs to be consistent with.

all other boundary conditions

Definition at line 397 of file motionSmootherAlgo.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), GeometricBoundaryField< Type, PatchField, GeoMesh >::evaluate(), HashTable< T, Key, Hash >::found(), DimensionedField< Type, GeoMesh >::mesh(), MeshObject< pointMesh, UpdateableMeshObject, pointConstraints >::New(), patchIDs(), and UPstream::scheduled.

Here is the call graph for this function:

◆ setDisplacementPatchFields() [2/2]

void setDisplacementPatchFields ( )

Set patch fields on displacement to be consistent with.

internal values.

Definition at line 454 of file motionSmootherAlgo.C.

◆ setDisplacement() [1/2]

void setDisplacement	(	const labelList &	patchIDs,
		const indirectPrimitivePatch &	pp,
		pointField &	patchDisp,
		pointVectorField &	displacement
	)

static

Set displacement field from displacement on patch points.

Modify provided displacement to be consistent with actual boundary conditions on displacement. Note: resets the displacement to be 0 on coupled patches beforehand to make sure shared points partially on pp (on some processors) and partially not (on other processors) get the value from pp.

Definition at line 461 of file motionSmootherAlgo.C.

References globalMeshData::coupledPatch(), IOobject::db(), Foam::ensightOutput::debug, Foam::endl(), forAll, polyMesh::globalData(), Foam::mag(), mesh, DimensionedField< Type, GeoMesh >::mesh(), PrimitivePatch< FaceList, PointField >::meshPoints(), OSstream::name(), primitiveMesh::nPoints(), patchIDs(), IOobject::path(), polyMesh::points(), Foam::Pout, pp(), syncTools::syncPointList(), Foam::meshTools::writeOBJ(), and Foam::Zero.

Referenced by snappyLayerDriver::addLayers(), snappySnapDriver::doSnap(), and snappySnapDriver::preSmoothPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDisplacement() [2/2]

void setDisplacement ( pointField & patchDisp )

Definition at line 555 of file motionSmootherAlgo.C.

◆ correctBoundaryConditions()

void correctBoundaryConditions ( pointVectorField & displacement ) const

Special correctBoundaryConditions which evaluates fixedValue.

patches first so they get overwritten with any constraint bc's.

Definition at line 563 of file motionSmootherAlgo.C.

References UPstream::blocking, GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), GeometricBoundaryField< Type, PatchField, GeoMesh >::evaluate(), HashTable< T, Key, Hash >::found(), DimensionedField< Type, GeoMesh >::mesh(), MeshObject< pointMesh, UpdateableMeshObject, pointConstraints >::New(), and syncTools::syncPointList().

Here is the call graph for this function:

◆ modifyMotionPoints()

void modifyMotionPoints ( pointField & newPoints ) const

Apply optional point constraint (2d correction)

Definition at line 629 of file motionSmootherAlgo.C.

References twoDPointCorrector::correctPoints(), Foam::ensightOutput::debug, Foam::constant::electromagnetic::e, Foam::endl(), forAll, Foam::Info, MeshObject< polyMesh, UpdateableMeshObject, twoDPointCorrector >::New(), twoDPointCorrector::normalEdgeIndices(), twoDPointCorrector::planeNormal(), Foam::Pout, twoDPointCorrector::required(), and WarningInFunction.

Here is the call graph for this function:

◆ curPoints()

Foam::tmp< Foam::pointField > curPoints ( ) const

Get the current points (oldPoints+scale*displacement)

Definition at line 741 of file motionSmootherAlgo.C.

References correctBoundaryConditions(), Foam::ensightOutput::debug, Foam::constant::electromagnetic::e, Foam::endl(), forAll, Foam::isA(), polyBoundaryMesh::mesh(), IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, pbm, Foam::Pout, GeometricField< Type, PatchField, GeoMesh >::primitiveField(), List< T >::setSize(), and UPtrList< T >::size().

Here is the call graph for this function:

◆ setErrorReduction()

Foam::scalar setErrorReduction ( const scalar errorReduction )

Set the errorReduction (by how much to scale the displacement.

at error locations) parameter. Returns the old value. Set to 0 (so revert to old mesh) grows out one cell layer from error faces.

Definition at line 690 of file motionSmootherAlgo.C.

Referenced by snappySnapDriver::preSmoothPatch(), and snappySnapDriver::scaleMesh().

Here is the caller graph for this function:

◆ scaleMesh() [1/3]

bool scaleMesh	(	labelList &	checkFaces,
		const bool	smoothMesh = `true`,
		const label	nAllow = `0`
	)

Move mesh with given scale. Return true if mesh ok or has.

less than nAllow errors, false otherwise and locally update scale. Smoothmesh=false means only patch points get moved. Parallel ok (as long as displacement field is consistent across patches)

Definition at line 704 of file motionSmootherAlgo.C.

Referenced by snappySnapDriver::preSmoothPatch(), and snappySnapDriver::scaleMesh().

Here is the caller graph for this function:

◆ scaleMesh() [2/3]

bool scaleMesh	(	labelList &	checkFaces,
		const List< labelPair > &	baffles,
		const bool	smoothMesh = `true`,
		const label	nAllow = `0`
	)

Move mesh (with baffles) with given scale.

Definition at line 722 of file motionSmootherAlgo.C.

◆ scaleMesh() [3/3]

bool scaleMesh	(	labelList &	checkFaces,
		const List< labelPair > &	baffles,
		const dictionary &	paramDict,
		const dictionary &	meshQualityDict,
		const bool	smoothMesh = `true`,
		const label	nAllow = `0`
	)

Move mesh with externally provided mesh constraints.

Definition at line 815 of file motionSmootherAlgo.C.

References coupled, Foam::ensightOutput::debug, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::gMax(), Foam::gMin(), Foam::Info, HashSet< Key, Hash >::insert(), Foam::mag(), Foam::nl, patches, Foam::Pout, pp(), keyType::REGEX_RECURSIVE, Foam::returnReduce(), HashTable< T, Key, Hash >::size(), pointSet::sync(), and syncTools::syncPointList().

Here is the call graph for this function:

◆ movePoints()

void movePoints ( )

Update for new mesh geometry.

Definition at line 680 of file motionSmootherAlgo.C.

◆ updateMesh()

void updateMesh ( )

Update for new mesh topology.

Definition at line 1025 of file motionSmootherAlgo.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, syncTools::getMasterEdges(), IOobject::name(), Foam::nl, and patches.

Here is the call graph for this function:

◆ checkMesh() [1/5]

bool checkMesh	(	const bool	report,
		const polyMesh &	mesh,
		const dictionary &	dict,
		labelHashSet &	wrongFaces,
		const bool	dryRun = `false`
	)

static

Check mesh with mesh settings in dict. Collects incorrect faces.

in set. Returns true if one or more faces in error. Parallel ok.

Definition at line 497 of file motionSmootherAlgoCheck.C.

References dict, Foam::identity(), and mesh.

Referenced by snappyLayerDriver::doLayers(), snappySnapDriver::doSnap(), and meshRefinement::splitFacesUndo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkMesh() [2/5]

bool checkMesh	(	const bool	report,
		const polyMesh &	mesh,
		const dictionary &	dict,
		const labelList &	checkFaces,
		labelHashSet &	wrongFaces,
		const bool	dryRun = `false`
	)

static

Check (subset of mesh) with mesh settings in dict.

Collects incorrect faces in set. Returns true if one or more faces in error. Parallel ok.

Definition at line 30 of file motionSmootherAlgoCheck.C.

References dict, and mesh.

◆ checkMesh() [3/5]

bool checkMesh	(	const bool	report,
		const polyMesh &	mesh,
		const dictionary &	dict,
		const labelList &	checkFaces,
		const List< labelPair > &	baffles,
		labelHashSet &	wrongFaces,
		const bool	dryRun = `false`
	)

static

Check (subset of mesh including baffles) with mesh settings.

in dict. Collects incorrect faces in set. Returns true if one or more faces in error. Parallel ok.

Definition at line 53 of file motionSmootherAlgoCheck.C.

References error::clear(), dict, Foam::endl(), Foam::FatalError, Foam::FatalIOError, Foam::Info, HashSet< Key, Hash >::insert(), IOWarningInFunction, mesh, error::message(), Foam::nl, pFaces, Foam::returnReduce(), Foam::setw(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

◆ checkMesh() [4/5]

bool checkMesh	(	const bool	report,
		const dictionary &	dict,
		const polyMeshGeometry &	meshGeom,
		const pointField &	points,
		const labelList &	checkFaces,
		labelHashSet &	wrongFaces,
		const bool	dryRun = `false`
	)

static

Check part of mesh with mesh settings in dict.

Collects incorrect faces in set. Returns true if one or more faces in error. Parallel ok.

Definition at line 517 of file motionSmootherAlgoCheck.C.

References dict, and points.

◆ checkMesh() [5/5]

bool checkMesh	(	const bool	report,
		const dictionary &	dict,
		const polyMeshGeometry &	meshGeom,
		const pointField &	points,
		const labelList &	checkFaces,
		const List< labelPair > &	baffles,
		labelHashSet &	wrongFaces,
		const bool	dryRun = `false`
	)

static

Check part of mesh including baffles with mesh settings in dict.

Collects incorrect faces in set. Returns true if one or more faces in error. Parallel ok.

Definition at line 544 of file motionSmootherAlgoCheck.C.

Here is the call graph for this function:

◆ smooth()

void smooth	(	const GeometricField< Type, pointPatchField, pointMesh > &	fld,
		const scalarField &	edgeWeight,
		GeometricField< Type, pointPatchField, pointMesh > &	newFld
	)		const

Fully explicit smoothing of fields (not positions)

of internal points with varying diffusivity.

Definition at line 226 of file motionSmootherAlgoTemplates.C.

References constrain(), fld, forAll, and MeshObject< pointMesh, UpdateableMeshObject, pointConstraints >::New().

Referenced by snappySnapDriver::smoothDisplacement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get()

Type get	(	const dictionary &	dict,
		const word &	keyword,
		const bool	noExit,
		enum keyType::option	matchOpt,
		const Type &	defaultValue = `Zero`
	)

static

Wrapper around dictionary::get which does not exit.

Definition at line 288 of file motionSmootherAlgoTemplates.C.

References dict, Foam::endl(), Foam::FatalIOError, IOobjectOption::MUST_READ, dictionary::name(), IOobjectOption::READ_IF_PRESENT, and dictionary::readEntry().

Here is the call graph for this function:

◆ avg()

Foam::tmp<Foam::GeometricField<Type, Foam::pointPatchField, Foam::pointMesh> > avg	(	const GeometricField< Type, pointPatchField, pointMesh > &	fld,
		const scalarField &	edgeWeight
	)		const

Definition at line 135 of file motionSmootherAlgoTemplates.C.

References constrain(), Foam::constant::electromagnetic::e, primitiveMesh::edges(), fld, forAll, Foam::mag(), mesh, MeshObject< pointMesh, UpdateableMeshObject, pointConstraints >::New(), Foam::New(), IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, primitiveMesh::nPoints(), syncTools::syncPointList(), and Foam::Zero.

Here is the call graph for this function:

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

src/dynamicMesh/motionSmoother/motionSmootherAlgo.H
src/dynamicMesh/motionSmoother/motionSmootherAlgo.C
src/dynamicMesh/motionSmoother/motionSmootherAlgoCheck.C
src/dynamicMesh/motionSmoother/motionSmootherAlgoTemplates.C

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ motionSmootherAlgo()

◆ ~motionSmootherAlgo()

Member Function Documentation

◆ ClassName()

◆ mesh()

◆ pMesh()

◆ patch()

◆ adaptPatchIDs()

◆ paramDict()

◆ pointDisplacement() [1/2]

◆ pointDisplacement() [2/2]

◆ correct()

◆ setDisplacementPatchFields() [1/2]

◆ setDisplacementPatchFields() [2/2]

◆ setDisplacement() [1/2]

◆ setDisplacement() [2/2]

◆ correctBoundaryConditions()

◆ modifyMotionPoints()

◆ curPoints()

◆ setErrorReduction()

◆ scaleMesh() [1/3]

◆ scaleMesh() [2/3]

◆ scaleMesh() [3/3]

◆ movePoints()

◆ updateMesh()

◆ checkMesh() [1/5]

◆ checkMesh() [2/5]

◆ checkMesh() [3/5]

◆ checkMesh() [4/5]

◆ checkMesh() [5/5]

◆ smooth()

◆ get()

◆ avg()