DASimpleFoam.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v3
 
    Description:
        Child class for DASimpleFoam
    
    This class is modified from OpenFOAM's source code
    applications/solvers/incompressible/simpleFoam
 
    OpenFOAM: The Open Source CFD Toolbox
 
    Copyright (C): 2011-2016 OpenFOAM Foundation
 
    OpenFOAM License:
 
        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/>.
 
\*---------------------------------------------------------------------------*/
 
#ifndef DASimpleFoam_H
#define DASimpleFoam_H
 
#include "DASolver.H"
#include "addToRunTimeSelectionTable.H"
#include "singlePhaseTransportModel.H"
#include "turbulentTransportModel.H"
#include "simpleControl.H"
#include "DARegDbSinglePhaseTransportModel.H"
#include "DARegDbTurbulenceModelIncompressible.H"
#include "DAFvSource.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
      Class DASimpleFoam Declaration
\*---------------------------------------------------------------------------*/
 
class DASimpleFoam
    : public DASolver
{
 
protected:
    autoPtr<simpleControl> simplePtr_;
 
    autoPtr<volScalarField> pPtr_;
 
    autoPtr<volVectorField> UPtr_;
 
    autoPtr<surfaceScalarField> phiPtr_;
 
    autoPtr<volScalarField> alphaPorosityPtr_;
 
    autoPtr<singlePhaseTransportModel> laminarTransportPtr_;
 
    autoPtr<incompressible::turbulenceModel> turbulencePtr_;
 
    autoPtr<DATurbulenceModel> daTurbulenceModelPtr_;
 
    autoPtr<DAFvSource> daFvSourcePtr_;
 
    autoPtr<volVectorField> fvSourcePtr_;
 
    autoPtr<IOMRFZoneListDF> MRFPtr_;
 
    label hasFvSource_ = 0;
 
    scalar cumulativeContErr_ = 0.0;
 
    label pRefCell_ = 0;
 
    scalar pRefValue_ = 0.0;
 
#ifdef CODI_AD_REVERSE
    using Position = typename codi::RealReverse::Tape::Position;
    Position adjResStart_;
    Position adjResEnd_;
    Position gradPStart_;
    Position gradPEnd_;
    Position pEqnFluxStart_;
    Position pEqnFluxEnd_;
    Position divPhiStart_;
    Position divPhiEnd_;
    Position fluxUStart_;
    Position fluxUEnd_;
#endif
 
    scalar relaxUEqn_ = 1.0;
    dictionary solverDictU_;
    dictionary solverDictP_;
 
public:
    TypeName("DASimpleFoam");
    // Constructors
 
    //- Construct from components
    DASimpleFoam(
        char* argsAll,
        PyObject* pyOptions);
 
    //- Destructor
    virtual ~DASimpleFoam()
    {
    }
 
    virtual void initSolver();
 
    virtual label solvePrimal(
        const Vec xvVec,
        Vec wVec);
 
    virtual label runFPAdj(
        const Vec xvVec,
        const Vec wVec,
        Vec dFdW,
        Vec psi);
 
    void invTranProdUEqn(
        const volVectorField& mySource,
        volVectorField& pseudoU);
 
    void invTranProdPEqn(
        const volScalarField& mySource,
        volScalarField& pseudoP);
 
    void calcLduResiduals(
        volVectorField& URes,
        volScalarField& pRes,
        surfaceScalarField& phiRes);
 
    void vec2Fields(
        const word mode,
        Vec cVec,
        volVectorField& UField,
        volScalarField& pField,
        surfaceScalarField& phiField,
        volScalarField& nuTildaField);
 
    void calcAdjointResidual(
        volVectorField& URes,
        volScalarField& pRes,
        surfaceScalarField& phiRes,
        volScalarField& nuTildaRes,
        Vec dFdW,
        volVectorField& UPsi,
        volScalarField& pPsi,
        surfaceScalarField& phiPsi,
        volScalarField& nuTildaPsi,
        volVectorField& adjURes,
        volScalarField& adjPRes,
        surfaceScalarField& adjPhiRes,
        volScalarField& adjNuTildaRes,
        label& cnt);
 
    scalar L2norm(const volScalarField& v);
 
    vector L2norm(const volVectorField& U);
 
    scalar L2norm(const surfaceScalarField& Phi);
 
    void swap(List<scalar>& a, List<scalar>& b);
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //