From 333b8d9d469d620b3f04905ad4c5bdfdf957e442 Mon Sep 17 00:00:00 2001 From: Elwardi Date: Sat, 22 Aug 2026 13:32:03 +0200 Subject: [PATCH 01/10] feat: overset support for AMR and load balancing --- README.md | 34 +++ src/dynamicFvMesh/Make/files | 1 + src/dynamicFvMesh/Make/options | 2 + .../adaptiveOversetFvMesh.C | 181 ++++++++++++ .../adaptiveOversetFvMesh.H | 166 +++++++++++ src/dynamicMesh/Make/files | 2 + src/dynamicMesh/Make/options | 2 + src/dynamicMesh/amrCore/amrCore.C | 19 ++ src/dynamicMesh/amrCore/amrCore.H | 9 + src/dynamicMesh/fvMeshBalance/fvMeshBalance.C | 23 +- .../oversetHandler/oversetHandler.C | 278 ++++++++++++++++++ .../oversetHandler/oversetHandler.H | 181 ++++++++++++ src/functionObjects/Make/options | 2 + tests/adaptiveFvMeshTests/Make/options | 3 +- tutorials/oversetHeatTransfer/0.orig/T | 44 +++ .../0.orig/cellDisplacement | 43 +++ .../0.orig/pointDisplacement | 43 +++ tutorials/oversetHeatTransfer/0.orig/zoneID | 32 ++ tutorials/oversetHeatTransfer/Allclean | 8 + tutorials/oversetHeatTransfer/Allrun | 15 + tutorials/oversetHeatTransfer/Allrun.pre | 21 ++ .../constant/dynamicMeshDict | 54 ++++ .../constant/transportProperties | 20 ++ .../oversetHeatTransfer/system/blockMeshDict | 124 ++++++++ .../oversetHeatTransfer/system/controlDict | 51 ++++ .../system/decomposeParDict | 27 ++ .../oversetHeatTransfer/system/fvSchemes | 79 +++++ .../oversetHeatTransfer/system/fvSolution | 58 ++++ .../oversetHeatTransfer/system/setFieldsDict | 48 +++ .../oversetHeatTransfer/system/topoSetDict | 67 +++++ 30 files changed, 1634 insertions(+), 3 deletions(-) create mode 100644 src/dynamicFvMesh/adaptiveOversetFvMesh/adaptiveOversetFvMesh.C create mode 100644 src/dynamicFvMesh/adaptiveOversetFvMesh/adaptiveOversetFvMesh.H create mode 100644 src/dynamicMesh/oversetHandler/oversetHandler.C create mode 100644 src/dynamicMesh/oversetHandler/oversetHandler.H create mode 100644 tutorials/oversetHeatTransfer/0.orig/T create mode 100644 tutorials/oversetHeatTransfer/0.orig/cellDisplacement create mode 100644 tutorials/oversetHeatTransfer/0.orig/pointDisplacement create mode 100644 tutorials/oversetHeatTransfer/0.orig/zoneID create mode 100755 tutorials/oversetHeatTransfer/Allclean create mode 100755 tutorials/oversetHeatTransfer/Allrun create mode 100755 tutorials/oversetHeatTransfer/Allrun.pre create mode 100644 tutorials/oversetHeatTransfer/constant/dynamicMeshDict create mode 100644 tutorials/oversetHeatTransfer/constant/transportProperties create mode 100644 tutorials/oversetHeatTransfer/system/blockMeshDict create mode 100644 tutorials/oversetHeatTransfer/system/controlDict create mode 100644 tutorials/oversetHeatTransfer/system/decomposeParDict create mode 100644 tutorials/oversetHeatTransfer/system/fvSchemes create mode 100644 tutorials/oversetHeatTransfer/system/fvSolution create mode 100644 tutorials/oversetHeatTransfer/system/setFieldsDict create mode 100644 tutorials/oversetHeatTransfer/system/topoSetDict diff --git a/README.md b/README.md index cbccb59c..b0dcc008 100644 --- a/README.md +++ b/README.md @@ -38,3 +38,37 @@ To get started, you can visit the one and only [wiki page](https://github.com/ST - Everything compiles to your `$FOAM_USER_LIBBIN` with a recent ESI ([openfoam.com](https://openfoam.com)) version. - Our favorite refinement cell selector is the [`coded`](https://github.com/STFS-TUDa/blastAMR/blob/0e70469d718ee53a5ce892e0e24a4f940bfba369/tutorials/poly_freelyPropFlame2D_H2/constant/dynamicMeshDict#L25). Although a wide range of selectors is provided, they are not well tested. So, use the coded refinement whenever possible. + +## Overset meshes + +`adaptiveOversetFvMesh` is `dynamicOversetFvMesh` with AMR and load balancing on +top, so mesh motion, refinement and balancing are all driven from a single +`constant/dynamicMeshDict`: + +``` +dynamicFvMesh adaptiveOversetFvMesh; + +solvers +{} // or a motionSolver list, as for dynamicOversetFvMesh + +adaptiveOversetFvMeshCoeffs +{ + // the usual blastAMR settings +} +``` + +Zone book-keeping across topology changes and redistribution is handled by a +run-time selectable `oversetHandler`, picked up automatically for any mesh with +an `overset` patch. Set `oversetHandler none;` to switch it off, or register +your own type if you use custom `cellCellStencil` code: + +``` +class myHandler : public oversetHandler { ... }; +addToRunTimeSelectionTable(oversetHandler, myHandler, mesh); +``` + +See `tutorials/oversetHeatTransfer`. Known limitations: refinement driven by the +`loadBalancedAMR` function object needs `adaptiveOversetFvMesh` (the function +object on a stock `dynamicOversetFvMesh` covers load balancing only), and +unrefinement leaves the flux on coarsened faces inconsistent, which sensitive +overset cases will not tolerate. diff --git a/src/dynamicFvMesh/Make/files b/src/dynamicFvMesh/Make/files index 69724fd1..e1f85bd4 100644 --- a/src/dynamicFvMesh/Make/files +++ b/src/dynamicFvMesh/Make/files @@ -1,3 +1,4 @@ adaptiveFvMesh/adaptiveFvMesh.C +adaptiveOversetFvMesh/adaptiveOversetFvMesh.C LIB = $(FOAM_USER_LIBBIN)/libamrDynamicFvMesh diff --git a/src/dynamicFvMesh/Make/options b/src/dynamicFvMesh/Make/options index 7147d6c4..d973d85c 100644 --- a/src/dynamicFvMesh/Make/options +++ b/src/dynamicFvMesh/Make/options @@ -3,6 +3,7 @@ EXE_INC = $(DEBUG_FLAGS) --std=c++17 \ -I$(LIB_SRC)/finiteVolume/lnInclude \ -I$(LIB_SRC)/dynamicMesh/lnInclude \ -I$(LIB_SRC)/dynamicFvMesh/lnInclude \ + -I$(LIB_SRC)/overset/lnInclude \ -I$(LIB_SRC)/lagrangian/basic/lnInclude \ -I$(LIB_SRC)/sampling/lnInclude \ -I$(LIB_SRC)/surfMesh/lnInclude \ @@ -19,6 +20,7 @@ LIB_LIBS = \ -lfiniteVolume \ -ldynamicMesh \ -ldynamicFvMesh \ + -loverset \ -llagrangian \ -lsampling \ -lsurfMesh \ diff --git a/src/dynamicFvMesh/adaptiveOversetFvMesh/adaptiveOversetFvMesh.C b/src/dynamicFvMesh/adaptiveOversetFvMesh/adaptiveOversetFvMesh.C new file mode 100644 index 00000000..8c877572 --- /dev/null +++ b/src/dynamicFvMesh/adaptiveOversetFvMesh/adaptiveOversetFvMesh.C @@ -0,0 +1,181 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2025 + \\/ M anipulation | +------------------------------------------------------------------------------- +License + This file is a derivative work 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 . + +\*---------------------------------------------------------------------------*/ + +#include "adaptiveOversetFvMesh.H" +#include "addToRunTimeSelectionTable.H" +#include "cloudSupport.H" +#include "sampledSurfaceWorkaround.H" + +// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // + +namespace Foam +{ + defineTypeNameAndDebug(adaptiveOversetFvMesh, 0); + addToRunTimeSelectionTable + ( + dynamicFvMesh, + adaptiveOversetFvMesh, + IOobject + ); +} + + +// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * // + +Foam::IOobject Foam::adaptiveOversetFvMesh::dynamicMeshDictIOobject +( + const IOobject& io +) +{ + // Not registered: dynamicOversetFvMesh reads the same dictionary + return IOobject + ( + "dynamicMeshDict", + io.time().constant(), + (io.name() == polyMesh::defaultRegion ? "" : io.name()), + io.db(), + IOobject::MUST_READ_IF_MODIFIED, + IOobject::NO_WRITE, + false + ); +} + + +// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * // + +void Foam::adaptiveOversetFvMesh::readDict() +{ + amrCore_.readDict + ( + dynamicMeshDict().optionalSubDict(typeName + "Coeffs") + ); +} + + +void Foam::adaptiveOversetFvMesh::updateMesh(const mapPolyMesh& mpm) +{ + // Motion solvers, mesh objects (including the overset stencil) and + // all registered fields. Unlike adaptiveFvMesh this runs before + // amrCore, so that flux correction sees fields already resized to the + // new topology + dynamicOversetFvMesh::updateMesh(mpm); + + // Flux correction and refiner update + amrCore_.updateMesh(mpm); + + // Clouds have to be remapped after fvMesh::updateMesh, see adaptiveFvMesh + cloudSupport::autoMapClouds(*this, mpm); + + expireSampledSurfaces(time(), amrCore_.expireSampledSurfacesOnLB()); +} + + +// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // + +Foam::adaptiveOversetFvMesh::adaptiveOversetFvMesh(const IOobject& io) +: + dynamicOversetFvMesh(io), + dynamicMeshDict_(dynamicMeshDictIOobject(io)), + amrCore_(*this), + currentTimeIndex_(-1) +{ + const dictionary refineDict + ( + dynamicMeshDict().optionalSubDict(typeName + "Coeffs") + ); + + amrCore_.initializeAMR(refineDict); + + if (refineDict.getOrDefault("balance", false)) + { + amrCore_.initializeLB(refineDict); + } +} + + +// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // + +bool Foam::adaptiveOversetFvMesh::refine() +{ + readDict(); + + return amrCore_.refine(); +} + + +bool Foam::adaptiveOversetFvMesh::update() +{ + // Mesh motion and, if it moved, the overset addressing + bool changed = dynamicOversetFvMesh::update(); + + if (currentTimeIndex_ >= time().timeIndex()) + { + return changed; + } + currentTimeIndex_ = time().timeIndex(); + + bool adapted = + ( + amrCore_.refiner().canRefine(true) + || amrCore_.refiner().canUnrefine(true) + ) + && refine(); + + if (amrCore_.lbInitialized() && Pstream::parRun() && amrCore_.balance()) + { + adapted = true; + } + + reduce(adapted, orOp()); + + if (adapted) + { + // The stencil was discarded with the old topology; rebuild the + // extended addressing and re-interpolate before the solver runs + oversetFvMeshBase::update(); + } + + return changed || adapted; +} + + +bool Foam::adaptiveOversetFvMesh::writeObject +( + IOstreamOption streamOpt, + const bool valid +) const +{ + // zoneID matching the adapted mesh, so that restarts do not fall back + // to the zoneID of the original mesh + if (amrCore_.oversetHandlerPtr()) + { + amrCore_.oversetHandlerPtr()->writeZoneID(); + } + + return dynamicOversetFvMesh::writeObject(streamOpt, valid); +} + + +// ************************************************************************* // diff --git a/src/dynamicFvMesh/adaptiveOversetFvMesh/adaptiveOversetFvMesh.H b/src/dynamicFvMesh/adaptiveOversetFvMesh/adaptiveOversetFvMesh.H new file mode 100644 index 00000000..249ad17e --- /dev/null +++ b/src/dynamicFvMesh/adaptiveOversetFvMesh/adaptiveOversetFvMesh.H @@ -0,0 +1,166 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2025 + \\/ M anipulation | +------------------------------------------------------------------------------- +License + This file is a derivative work 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 . + +Class + Foam::adaptiveOversetFvMesh + +Description + dynamicOversetFvMesh with adaptive mesh refinement and load balancing. + + Inherits the whole overset machinery (extended ldu addressing, implicit + and explicit interpolation, mesh motion through the motion solver list) + from dynamicOversetFvMesh and adds blastAMR's amrCore on top, so a + single dynamicMeshDict drives motion, refinement and balancing: + + \verbatim + dynamicFvMesh adaptiveOversetFvMesh; + + solver multiSolidBodyMotionSolver; + multiSolidBodyMotionSolverCoeffs { ... } + + adaptiveOversetFvMeshCoeffs + { + errorEstimator ...; + balance yes; + ... + } + \endverbatim + + Overset zone book-keeping across refinement and balancing is done by the + oversetHandler registered by amrCore. + +SourceFiles + adaptiveOversetFvMesh.C + +\*---------------------------------------------------------------------------*/ + +#ifndef adaptiveOversetFvMesh_H +#define adaptiveOversetFvMesh_H + +#include "dynamicOversetFvMesh.H" +#include "amrCore.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ + +/*---------------------------------------------------------------------------*\ + Class adaptiveOversetFvMesh Declaration +\*---------------------------------------------------------------------------*/ + +class adaptiveOversetFvMesh +: + public dynamicOversetFvMesh +{ + //- Return the dynamicMeshDict IOobject + static IOobject dynamicMeshDictIOobject(const IOobject& io); + + +protected: + + //- The dynamicMeshDict + IOdictionary dynamicMeshDict_; + + //- Core AMR/LB functionality + amrCore amrCore_; + + //- Do mesh updates only once per timestep + label currentTimeIndex_; + + + // Protected Member Functions + + //- Read the AMR settings + void readDict(); + + //- Overload update mesh to include other methods + virtual void updateMesh(const mapPolyMesh& mpm); + + +public: + + //- Runtime type information + TypeName("adaptiveOversetFvMesh"); + + + // Constructors + + //- Construct from IOobject + explicit adaptiveOversetFvMesh(const IOobject& io); + + //- No copy construct + adaptiveOversetFvMesh(const adaptiveOversetFvMesh&) = delete; + + + //- Destructor + virtual ~adaptiveOversetFvMesh() = default; + + + // Member Functions + + //- Return the dynamicMeshDict + const dictionary& dynamicMeshDict() const + { + return dynamicMeshDict_; + } + + //- Direct access to the refinement engine + const fvMeshRefiner& refiner() const + { + return amrCore_.refiner(); + } + + //- Update the mesh for motion, topology change and balancing + virtual bool update(); + + //- Refine the mesh + bool refine(); + + + // Writing + + //- Write using given format, version and compression + virtual bool writeObject + ( + IOstreamOption streamOpt, + const bool valid + ) const; + + + // Member Operators + + //- No copy assignment + void operator=(const adaptiveOversetFvMesh&) = delete; +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/src/dynamicMesh/Make/files b/src/dynamicMesh/Make/files index 83aa5b3e..1c34c287 100644 --- a/src/dynamicMesh/Make/files +++ b/src/dynamicMesh/Make/files @@ -32,6 +32,8 @@ fvMeshRefiner/fvMeshPolyRefiner/polyRefinementConstraint.C meshTools/dynMeshTools.C +oversetHandler/oversetHandler.C + amrCore/amrCore.C LIB = $(FOAM_USER_LIBBIN)/libamrDynamicMesh diff --git a/src/dynamicMesh/Make/options b/src/dynamicMesh/Make/options index 07849fed..424b55a5 100644 --- a/src/dynamicMesh/Make/options +++ b/src/dynamicMesh/Make/options @@ -3,6 +3,7 @@ EXE_INC = $(DEBUG_FLAGS) --std=c++17 \ -I$(LIB_SRC)/meshTools/lnInclude \ -I$(LIB_SRC)/dynamicMesh/lnInclude \ -I$(LIB_SRC)/dynamicFvMesh/lnInclude \ + -I$(LIB_SRC)/overset/lnInclude \ -I$(LIB_SRC)/parallel/decompose/decompositionMethods/lnInclude \ -I$(LIB_SRC)/lagrangian/basic/lnInclude \ -I$(LIB_SRC)/sampling/lnInclude \ @@ -18,6 +19,7 @@ LIB_LIBS = \ -lfiniteVolume \ -ldynamicMesh \ -ldynamicFvMesh \ + -loverset \ -ldecompositionMethods \ -llagrangian \ -lsampling \ diff --git a/src/dynamicMesh/amrCore/amrCore.C b/src/dynamicMesh/amrCore/amrCore.C index bb63f596..f1352bc1 100644 --- a/src/dynamicMesh/amrCore/amrCore.C +++ b/src/dynamicMesh/amrCore/amrCore.C @@ -76,6 +76,9 @@ void Foam::amrCore::initializeAMR(const dictionary& dict) // Create refiner refiner_ = fvMeshRefiner::New(mesh_, dict, false, true); + // Overset meshes need their zone book-keeping mapped along with the mesh + oversetHandler::New(mesh_, dict); + // Read flux correction settings readCorrectFluxes(dict); @@ -122,6 +125,8 @@ void Foam::amrCore::initializeLB(const dictionary& dict) refiner_ = fvMeshRefiner::New(mesh_, minimalDict, false, true); } + oversetHandler::New(mesh_, dict); + // Configure balancer within refiner refiner_->balancer().read(dict); @@ -204,6 +209,14 @@ bool Foam::amrCore::refine() Info<< "Protecting " << returnReduce(nProtected, sumOp