functionObjects::checkMesh: New functionObject to check mesh changes

Class
    Foam::functionObjects::checkMesh

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.

    Example of checkMesh specification:
    \verbatim
    checkMesh
    {
        type            checkMesh;
        libs            ("libutilityFunctionObjects.so");

        executeControl  timeStep;
        executeInterval 10;
    }
    \endverbatim
    or using the standard configuration file:
    \verbatim
    #includeFunc checkMesh(executeInterval=10)
    \endverbatim

Can be used with any solver supporting mesh-motion, in particular the movingMesh
solver module, to check the mesh quality following morphing and/or topology
change.

src/functionObjects/utilities/Make/files

@@ -13,5 +13,6 @@ removeRegisteredObject/removeRegisteredObject.C
 writeDictionary/writeDictionary.C
 writeObjects/writeObjects.C
 time/timeFunctionObject.C
+checkMesh/checkMesh.C
 
 LIB = $(FOAM_LIBBIN)/libutilityFunctionObjects

src/functionObjects/utilities/checkMesh/checkMesh.C

@@ -0,0 +1,84 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     | Website:  https://openfoam.org
+    \\  /    A nd           | Copyright (C) 2023 OpenFOAM Foundation
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+\*---------------------------------------------------------------------------*/
+
+#include "checkMesh.H"
+#include "fvMesh.H"
+#include "addToRunTimeSelectionTable.H"
+
+// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace functionObjects
+{
+    defineTypeNameAndDebug(checkMesh, 0);
+    addToRunTimeSelectionTable(functionObject, checkMesh, dictionary);
+}
+}
+
+
+// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
+
+Foam::functionObjects::checkMesh::checkMesh
+(
+    const word& name,
+    const Time& runTime,
+    const dictionary& dict
+)
+:
+    fvMeshFunctionObject(name, runTime, dict)
+{
+    read(dict);
+}
+
+
+// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
+
+Foam::functionObjects::checkMesh::~checkMesh()
+{}
+
+
+// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
+
+bool Foam::functionObjects::checkMesh::execute()
+{
+    if (mesh_.changing())
+    {
+        return mesh_.checkMesh(true);
+    }
+    else
+    {
+        return true;
+    }
+}
+
+
+bool Foam::functionObjects::checkMesh::write()
+{
+    return true;
+}
+
+
+// ************************************************************************* //

src/functionObjects/utilities/checkMesh/checkMesh.H

@@ -0,0 +1,122 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     | Website:  https://openfoam.org
+    \\  /    A nd           | Copyright (C) 2023 OpenFOAM Foundation
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+Class
+    Foam::functionObjects::checkMesh
+
+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.
+
+    Example of checkMesh specification:
+    \verbatim
+    checkMesh
+    {
+        type            checkMesh;
+        libs            ("libutilityFunctionObjects.so");
+
+        executeControl  timeStep;
+        executeInterval 10;
+    }
+    \endverbatim
+    or using the standard configuration file:
+    \verbatim
+    #includeFunc checkMesh(executeInterval=10)
+    \endverbatim
+
+SourceFiles
+    checkMesh.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef functionObjects_checkMesh_H
+#define functionObjects_checkMesh_H
+
+#include "fvMeshFunctionObject.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace functionObjects
+{
+
+/*---------------------------------------------------------------------------*\
+                          Class checkMesh Declaration
+\*---------------------------------------------------------------------------*/
+
+class checkMesh
+:
+    public fvMeshFunctionObject
+{
+    // Private Data
+
+public:
+
+    //- Runtime type information
+    TypeName("checkMesh");
+
+
+    // Constructors
+
+        //- Construct from Time and dictionary
+        checkMesh
+        (
+            const word& name,
+            const Time&,
+            const dictionary&
+        );
+
+
+    //- Destructor
+    virtual ~checkMesh();
+
+
+    // Member Functions
+
+        //- Return the list of fields required
+        virtual wordList fields() const
+        {
+            return wordList::null();
+        }
+
+        //- Execute primitiveMesh::checkMesh(true)
+        virtual bool execute();
+
+        //- Do nothing
+        virtual bool write();
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace functionObjects
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //