Modular solvers: Reorganised directory structure of applications and tutorials

The new flexible and extensible modular solvers structure already provides most of the simulation functionality needed for single phase, multiphase, multicomponent etc. fluid flow problems as well as a very effective method of combining these with solid heat transfer, solid stress, surface film to solve complex multi-region, multi-physics problems and are now the primary mechanism for the further development of OpenFOAM simulation capability in future. To emphasis this for both users and developers the applications/solvers directory has been separated into applications/modules containing all the solver modules: ├── modules │ ├── compressibleMultiphaseVoF │ ├── compressibleVoF │ ├── film │ ├── fluid │ ├── fluidSolver │ ├── functions │ ├── incompressibleDenseParticleFluid │ ├── incompressibleDriftFlux │ ├── incompressibleFluid │ ├── incompressibleMultiphaseVoF │ ├── incompressibleVoF │ ├── isothermalFilm │ ├── isothermalFluid │ ├── movingMesh │ ├── multicomponentFluid │ ├── multiphaseEuler │ ├── multiphaseVoFSolver │ ├── shockFluid │ ├── solid │ ├── solidDisplacement │ ├── twoPhaseSolver │ ├── twoPhaseVoFSolver │ ├── VoFSolver │ └── XiFluid applications/solvers containing the foamRun and foamMultiRun solver applications which instantiate and execute the chosen solver modules and also standalone solver applications for special initialisation and test activities: ├── solvers │ ├── boundaryFoam │ ├── chemFoam │ ├── foamMultiRun │ ├── foamRun │ └── potentialFoam and applications/legacy containing legacy solver applications which are not currently being actively developed but the functionality of which will be merged into the solver modules or form the basis of new solver modules as the need arises: ├── legacy │ ├── basic │ │ ├── financialFoam │ │ └── laplacianFoam │ ├── combustion │ │ └── PDRFoam │ ├── compressible │ │ └── rhoPorousSimpleFoam │ ├── electromagnetics │ │ ├── electrostaticFoam │ │ ├── magneticFoam │ │ └── mhdFoam │ ├── incompressible │ │ ├── adjointShapeOptimisationFoam │ │ ├── dnsFoam │ │ ├── icoFoam │ │ ├── porousSimpleFoam │ │ └── shallowWaterFoam │ └── lagrangian │ ├── dsmcFoam │ ├── mdEquilibrationFoam │ └── mdFoam Correspondingly the tutorials directory structure has been reorganised with the modular solver directories at the top level with names that make it easier for users to find example cases relating to their particular requirements and a legacy sub-directory containing cases corresponding to the legacy solver applications listed above: ├── compressibleMultiphaseVoF │ └── damBreak4phaseLaminar ├── compressibleVoF │ ├── ballValve │ ├── climbingRod │ ├── damBreak │ ├── depthCharge2D │ ├── depthCharge3D │ ├── sloshingTank2D │ └── throttle ├── film │ └── rivuletPanel ├── fluid │ ├── aerofoilNACA0012 │ ├── aerofoilNACA0012Steady │ ├── angledDuct │ ├── angledDuctExplicitFixedCoeff │ ├── angledDuctLTS │ ├── annularThermalMixer │ ├── BernardCells │ ├── blockedChannel │ ├── buoyantCavity │ ├── cavity │ ├── decompressionTank │ ├── externalCoupledCavity │ ├── forwardStep │ ├── helmholtzResonance │ ├── hotRadiationRoom │ ├── hotRadiationRoomFvDOM │ ├── hotRoom │ ├── hotRoomBoussinesq │ ├── hotRoomBoussinesqSteady │ ├── hotRoomComfort │ ├── iglooWithFridges │ ├── mixerVessel2DMRF │ ├── nacaAirfoil │ ├── pitzDaily │ ├── prism │ ├── shockTube │ ├── squareBend │ ├── squareBendLiq │ └── squareBendLiqSteady ├── incompressibleDenseParticleFluid │ ├── column │ ├── cyclone │ ├── Goldschmidt │ ├── GoldschmidtMPPIC │ └── injectionChannel ├── incompressibleDriftFlux │ ├── dahl │ ├── mixerVessel2DMRF │ └── tank3D ├── incompressibleFluid │ ├── airFoil2D │ ├── ballValve │ ├── blockedChannel │ ├── cavity │ ├── cavityCoupledU │ ├── channel395 │ ├── drivaerFastback │ ├── ductSecondaryFlow │ ├── elipsekkLOmega │ ├── flowWithOpenBoundary │ ├── hopperParticles │ ├── impeller │ ├── mixerSRF │ ├── mixerVessel2D │ ├── mixerVessel2DMRF │ ├── mixerVesselHorizontal2DParticles │ ├── motorBike │ ├── motorBikeSteady │ ├── movingCone │ ├── offsetCylinder │ ├── oscillatingInlet │ ├── pipeCyclic │ ├── pitzDaily │ ├── pitzDailyLES │ ├── pitzDailyLESDevelopedInlet │ ├── pitzDailyLTS │ ├── pitzDailyPulse │ ├── pitzDailyScalarTransport │ ├── pitzDailySteady │ ├── pitzDailySteadyExperimentalInlet │ ├── pitzDailySteadyMappedToPart │ ├── pitzDailySteadyMappedToRefined │ ├── planarContraction │ ├── planarCouette │ ├── planarPoiseuille │ ├── porousBlockage │ ├── propeller │ ├── roomResidenceTime │ ├── rotor2DRotating │ ├── rotor2DSRF │ ├── rotorDisk │ ├── T3A │ ├── TJunction │ ├── TJunctionFan │ ├── turbineSiting │ ├── waveSubSurface │ ├── windAroundBuildings │ └── wingMotion ├── incompressibleMultiphaseVoF │ ├── damBreak4phase │ ├── damBreak4phaseFineLaminar │ ├── damBreak4phaseLaminar │ └── mixerVessel2DMRF ├── incompressibleVoF │ ├── angledDuct │ ├── capillaryRise │ ├── cavitatingBullet │ ├── climbingRod │ ├── containerDischarge2D │ ├── damBreak │ ├── damBreakLaminar │ ├── damBreakPorousBaffle │ ├── damBreakWithObstacle │ ├── DTCHull │ ├── DTCHullMoving │ ├── DTCHullWave │ ├── floatingObject │ ├── floatingObjectWaves │ ├── forcedUpstreamWave │ ├── mixerVessel │ ├── mixerVessel2DMRF │ ├── mixerVesselHorizontal2D │ ├── nozzleFlow2D │ ├── planingHullW3 │ ├── propeller │ ├── sloshingCylinder │ ├── sloshingTank2D │ ├── sloshingTank2D3DoF │ ├── sloshingTank3D │ ├── sloshingTank3D3DoF │ ├── sloshingTank3D6DoF │ ├── testTubeMixer │ ├── waterChannel │ ├── wave │ ├── wave3D │ └── weirOverflow ├── isothermalFilm │ └── rivuletPanel ├── isothermalFluid │ ├── potentialFreeSurfaceMovingOscillatingBox │ └── potentialFreeSurfaceOscillatingBox ├── legacy │ ├── basic │ │ ├── financialFoam │ │ │ └── europeanCall │ │ └── laplacianFoam │ │ └── flange │ ├── combustion │ │ └── PDRFoam │ │ └── flamePropagationWithObstacles │ ├── compressible │ │ └── rhoPorousSimpleFoam │ │ ├── angledDuctExplicit │ │ └── angledDuctImplicit │ ├── electromagnetics │ │ ├── electrostaticFoam │ │ │ └── chargedWire │ │ └── mhdFoam │ │ └── hartmann │ ├── incompressible │ │ ├── adjointShapeOptimisationFoam │ │ │ └── pitzDaily │ │ ├── dnsFoam │ │ │ └── boxTurb16 │ │ ├── icoFoam │ │ │ ├── cavity │ │ │ └── elbow │ │ ├── porousSimpleFoam │ │ │ ├── angledDuctExplicit │ │ │ └── angledDuctImplicit │ │ └── shallowWaterFoam │ │ └── squareBump │ ├── lagrangian │ │ ├── dsmcFoam │ │ │ ├── freeSpacePeriodic │ │ │ ├── freeSpaceStream │ │ │ ├── supersonicCorner │ │ │ └── wedge15Ma5 │ │ ├── mdEquilibrationFoam │ │ │ ├── periodicCubeArgon │ │ │ └── periodicCubeWater │ │ └── mdFoam │ │ └── nanoNozzle ├── mesh │ ├── blockMesh │ │ ├── pipe │ │ ├── sphere │ │ ├── sphere7 │ │ └── sphere7ProjectedEdges │ ├── refineMesh │ │ └── refineFieldDirs │ └── snappyHexMesh │ ├── flange │ └── pipe ├── movingMesh │ └── SnakeRiverCanyon ├── multicomponentFluid │ ├── aachenBomb │ ├── counterFlowFlame2D │ ├── counterFlowFlame2D_GRI │ ├── counterFlowFlame2D_GRI_TDAC │ ├── counterFlowFlame2DLTS │ ├── counterFlowFlame2DLTS_GRI_TDAC │ ├── DLR_A_LTS │ ├── filter │ ├── lockExchange │ ├── membrane │ ├── nc7h16 │ ├── parcelInBox │ ├── SandiaD_LTS │ ├── simplifiedSiwek │ ├── smallPoolFire2D │ ├── smallPoolFire3D │ ├── verticalChannel │ ├── verticalChannelLTS │ └── verticalChannelSteady ├── multiphaseEuler │ ├── bed │ ├── bubbleColumn │ ├── bubbleColumnEvaporating │ ├── bubbleColumnEvaporatingDissolving │ ├── bubbleColumnEvaporatingReacting │ ├── bubbleColumnIATE │ ├── bubbleColumnLaminar │ ├── bubbleColumnLES │ ├── bubblePipe │ ├── damBreak4phase │ ├── fluidisedBed │ ├── fluidisedBedLaminar │ ├── Grossetete │ ├── hydrofoil │ ├── injection │ ├── LBend │ ├── mixerVessel2D │ ├── mixerVessel2DMRF │ ├── pipeBend │ ├── steamInjection │ ├── titaniaSynthesis │ ├── titaniaSynthesisSurface │ ├── wallBoilingIATE │ ├── wallBoilingPolydisperse │ └── wallBoilingPolydisperseTwoGroups ├── multiRegion │ ├── CHT │ │ ├── circuitBoardCooling │ │ ├── coolingCylinder2D │ │ ├── coolingSphere │ │ ├── heatedDuct │ │ ├── heatExchanger │ │ ├── multiphaseCoolingCylinder2D │ │ ├── reverseBurner │ │ ├── shellAndTubeHeatExchanger │ │ ├── VoFcoolingCylinder2D │ │ └── wallBoiling │ └── film │ ├── cylinder │ ├── cylinderDripping │ ├── cylinderVoF │ ├── hotBoxes │ ├── rivuletBox │ ├── rivuletPanel │ ├── splashPanel │ └── VoFToFilm ├── potentialFoam │ ├── cylinder │ └── pitzDaily ├── resources │ ├── blockMesh │ ├── geometry │ └── thermoData ├── shockFluid │ ├── biconic25-55Run35 │ ├── forwardStep │ ├── LadenburgJet60psi │ ├── movingCone │ ├── obliqueShock │ ├── shockTube │ └── wedge15Ma5 ├── solidDisplacement │ ├── beamEndLoad │ └── plateHole └── XiFluid ├── kivaTest └── moriyoshiHomogeneous
2023-05-25 18:14:41 +01:00
parent 20c181c5c0
commit e744fdb5f1
6180 changed files with 490 additions and 763 deletions
--- a/applications/legacy/basic/financialFoam/Make/files
+++ b/applications/legacy/basic/financialFoam/Make/files
@ -0,0 +1,3 @@
+financialFoam.C
+
+EXE = $(FOAM_APPBIN)/financialFoam
--- a/applications/legacy/basic/financialFoam/Make/options
+++ b/applications/legacy/basic/financialFoam/Make/options
@ -0,0 +1,9 @@
+EXE_INC = \
+    -I$(LIB_SRC)/finiteVolume/lnInclude \
+    -I$(LIB_SRC)/meshTools/lnInclude \
+    -I$(LIB_SRC)/sampling/lnInclude
+
+EXE_LIBS = \
+    -lfiniteVolume \
+    -lmeshTools \
+    -lsampling
--- a/applications/legacy/basic/financialFoam/createFields.H
+++ b/applications/legacy/basic/financialFoam/createFields.H
@ -0,0 +1,99 @@
+Info<< "Reading financial properties\n" << endl;
+
+IOdictionary financialProperties
+(
+    IOobject
+    (
+        "financialProperties",
+        runTime.constant(),
+        mesh,
+        IOobject::MUST_READ_IF_MODIFIED,
+        IOobject::NO_WRITE
+    )
+);
+
+dimensionedScalar strike
+(
+    "strike",
+    dimLength,
+    financialProperties.lookup("strike")
+);
+
+dimensionedScalar r
+(
+    "r",
+    dimless/dimTime,
+    financialProperties.lookup("r")
+);
+
+dimensionedScalar sigma
+(
+    "sigma",
+    dimensionSet(0, 0, -0.5, 0, 0),
+    financialProperties.lookup("sigma")
+);
+
+dimensionedScalar sigmaSqr = sqr(sigma);
+
+
+Info<< nl << "Reading field V" << endl;
+
+volScalarField V
+(
+    IOobject
+    (
+        "V",
+        runTime.name(),
+        mesh,
+        IOobject::MUST_READ,
+        IOobject::AUTO_WRITE
+    ),
+    mesh
+);
+
+
+surfaceVectorField Pf
+(
+    IOobject
+    (
+        "Pf",
+        runTime.name(),
+        mesh,
+        IOobject::NO_READ,
+        IOobject::NO_WRITE
+    ),
+    mesh.Cf()
+);
+
+
+volVectorField P
+(
+    IOobject
+    (
+        "P",
+        runTime.name(),
+        mesh,
+        IOobject::NO_READ,
+        IOobject::NO_WRITE
+    ),
+    mesh.C()
+);
+
+V == max
+(
+    P.component(Foam::vector::X) - strike,
+    dimensionedScalar(V.dimensions(), 0)
+);
+
+volScalarField delta
+(
+    IOobject
+    (
+        "delta",
+        runTime.name(),
+        mesh,
+        IOobject::NO_READ,
+        IOobject::AUTO_WRITE
+    ),
+    fvc::grad(V)().component(Foam::vector::X)
+);
--- a/applications/legacy/basic/financialFoam/financialFoam.C
+++ b/applications/legacy/basic/financialFoam/financialFoam.C
@ -0,0 +1,112 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     | Website:  https://openfoam.org
+    \\  /    A nd           | Copyright (C) 2011-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/>.
+
+Application
+    financialFoam
+
+Description
+    Solves the Black-Scholes equation to price commodities.
+
+\*---------------------------------------------------------------------------*/
+
+#include "argList.H"
+#include "timeSelector.H"
+#include "setWriter.H"
+#include "writeFile.H"
+
+#include "fvcGrad.H"
+
+#include "fvmDdt.H"
+#include "fvmDiv.H"
+#include "fvmLaplacian.H"
+
+using namespace Foam;
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+int main(int argc, char *argv[])
+{
+    #define NO_CONTROL
+    #include "postProcess.H"
+
+    #include "setRootCase.H"
+    #include "createTime.H"
+    #include "createMesh.H"
+    #include "createFields.H"
+
+    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+    Info<< nl << "Calculating value(price of commodities)" << endl;
+
+    surfaceScalarField phi("phi", (sigmaSqr - r)*(Pf & mesh.Sf()));
+
+    volScalarField DV("DV", 0.5*sigmaSqr*sqr(P.component(Foam::vector::X)));
+
+    Info<< "Starting time loop\n" << endl;
+
+    while (runTime.loop())
+    {
+        delta == fvc::grad(V)().component(Foam::vector::X);
+
+        solve
+        (
+            fvm::ddt(V)
+          + fvm::div(phi, V)
+          - fvm::Sp(fvc::div(phi), V)
+          - fvm::laplacian(DV, V)
+         ==
+          - fvm::Sp(r, V)
+        );
+
+        runTime.write();
+
+        if (runTime.writeTime())
+        {
+            setWriter::New(runTime.graphFormat())->write
+            (
+                runTime.globalPath()
+               /functionObjects::writeFile::outputPrefix
+               /args.executable()
+               /runTime.name(),
+
+                args.executable(),
+
+                coordSet(true, word::null, mesh.C().primitiveField(), "x"),
+
+                "V", V.primitiveField(),
+                "delta", delta.primitiveField()
+            );
+        }
+
+        Info<< "ExecutionTime = " << runTime.elapsedCpuTime() << " s"
+            << "  ClockTime = " << runTime.elapsedClockTime() << " s"
+            << nl << endl;
+    }
+
+    Info<< "End\n" << endl;
+
+    return 0;
+}
+
+
+// ************************************************************************* //
--- a/applications/legacy/basic/laplacianFoam/Make/files
+++ b/applications/legacy/basic/laplacianFoam/Make/files
@ -0,0 +1,3 @@
+laplacianFoam.C
+
+EXE = $(FOAM_APPBIN)/laplacianFoam
--- a/applications/legacy/basic/laplacianFoam/Make/options
+++ b/applications/legacy/basic/laplacianFoam/Make/options
@ -0,0 +1,9 @@
+EXE_INC = \
+    -I$(LIB_SRC)/finiteVolume/lnInclude \
+    -I$(LIB_SRC)/meshTools/lnInclude
+
+EXE_LIBS = \
+    -lfiniteVolume \
+    -lfvModels \
+    -lfvConstraints \
+    -lmeshTools
--- a/applications/legacy/basic/laplacianFoam/createFields.H
+++ b/applications/legacy/basic/laplacianFoam/createFields.H
@ -0,0 +1,40 @@
+Info<< "Reading field T\n" << endl;
+
+volScalarField T
+(
+    IOobject
+    (
+        "T",
+        runTime.name(),
+        mesh,
+        IOobject::MUST_READ,
+        IOobject::AUTO_WRITE
+    ),
+    mesh
+);
+
+
+Info<< "Reading physicalProperties\n" << endl;
+
+IOdictionary physicalProperties
+(
+    IOobject
+    (
+        "physicalProperties",
+        runTime.constant(),
+        mesh,
+        IOobject::MUST_READ_IF_MODIFIED,
+        IOobject::NO_WRITE
+    )
+);
+
+
+Info<< "Reading diffusivity DT\n" << endl;
+
+dimensionedScalar DT
+(
+    physicalProperties.lookup("DT")
+);
+
+#include "createFvModels.H"
+#include "createFvConstraints.H"
--- a/applications/legacy/basic/laplacianFoam/laplacianFoam.C
+++ b/applications/legacy/basic/laplacianFoam/laplacianFoam.C
@ -0,0 +1,91 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     | Website:  https://openfoam.org
+    \\  /    A nd           | Copyright (C) 2011-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/>.
+
+Application
+    laplacianFoam
+
+Description
+    Solves a simple Laplace equation, e.g. for thermal diffusion in a solid.
+
+\*---------------------------------------------------------------------------*/
+
+#include "argList.H"
+#include "fvModels.H"
+#include "fvConstraints.H"
+#include "simpleControl.H"
+
+#include "fvmLaplacian.H"
+
+using namespace Foam;
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+int main(int argc, char *argv[])
+{
+    #include "setRootCase.H"
+
+    #include "createTime.H"
+    #include "createMesh.H"
+
+    simpleControl simple(mesh);
+
+    #include "createFields.H"
+
+    // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+    Info<< "\nCalculating temperature distribution\n" << endl;
+
+    while (simple.loop(runTime))
+    {
+        Info<< "Time = " << runTime.userTimeName() << nl << endl;
+
+        fvModels.correct();
+
+        while (simple.correctNonOrthogonal())
+        {
+            fvScalarMatrix TEqn
+            (
+                fvm::ddt(T) - fvm::laplacian(DT, T)
+             ==
+                fvModels.source(T)
+            );
+
+            fvConstraints.constrain(TEqn);
+            TEqn.solve();
+            fvConstraints.constrain(T);
+        }
+
+        #include "write.H"
+
+        Info<< "ExecutionTime = " << runTime.elapsedCpuTime() << " s"
+            << "  ClockTime = " << runTime.elapsedClockTime() << " s"
+            << nl << endl;
+    }
+
+    Info<< "End\n" << endl;
+
+    return 0;
+}
+
+
+// ************************************************************************* //
--- a/applications/legacy/basic/laplacianFoam/write.H
+++ b/applications/legacy/basic/laplacianFoam/write.H
@ -0,0 +1,46 @@
+    if (runTime.writeTime())
+    {
+        volVectorField gradT(fvc::grad(T));
+
+        volScalarField gradTx
+        (
+            IOobject
+            (
+                "gradTx",
+                runTime.name(),
+                mesh,
+                IOobject::NO_READ,
+                IOobject::AUTO_WRITE
+            ),
+            gradT.component(vector::X)
+        );
+
+        volScalarField gradTy
+        (
+            IOobject
+            (
+                "gradTy",
+                runTime.name(),
+                mesh,
+                IOobject::NO_READ,
+                IOobject::AUTO_WRITE
+            ),
+            gradT.component(vector::Y)
+        );
+
+        volScalarField gradTz
+        (
+            IOobject
+            (
+                "gradTz",
+                runTime.name(),
+                mesh,
+                IOobject::NO_READ,
+                IOobject::AUTO_WRITE
+            ),
+            gradT.component(vector::Z)
+        );
+
+
+        runTime.write();
+    }