DAModel.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v4
 
    Description:
        DAModel is a general class for handling physical models in DAFoam. 
        The constructor for DAModel does not explicitly contain objects of 
        physical models. Instead, it will look up any model class, e.g., 
        DATurbulenceModel, DARaditionModel, that has been registred in fvMesh. 
        This enables the flexibility such that we can simultaneously have 
        multiple models for adjoint, e.g., turbulence model + radiation model.
        
        NOTE 1: in adjoint functions, we should call functions in DAModel to handle
        general model operation, e.g., call daModel.correctBoundaryCondition(), 
        instead of calling daTurbulenceModel.correctBoundaryCondition(). Because
        daModel.correctBoundaryCondition() will call the correctBoundaryCondition()
        in daTurbulenceModel and daRadiationModel, if these two models are used.
 
        NOTE 2: Because of the above feature, we need to initialize any physical
        model BEFORE initializing the DAModel, e.g.,
 
        // initialize DATurbulence and automatically register it to fvMesh
        autoPtr<DATurbulenceModel> daTurb(DATurbulenceModel::New(mesh));
        
        ............ // codes to initialize any other physical models
 
        // now we can initialize DAModel and lookup DATurbulenceModel in mesh
        DAModel daModel(mesh);
 
        Otherwise, the physical models will NOT be picked up by the DAModel
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAModel_H
#define DAModel_H
 
#include "fvOptions.H"
#include "DAOption.H"
#include "fvc.H"
#include "fvm.H"
#include "surfaceFields.H"
#include "geometricOneField.H"
#include "zeroGradientFvPatchField.H"
#include "DATurbulenceModel.H"
#include "DARadiationModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                       Class DAModel Declaration
\*---------------------------------------------------------------------------*/
 
class DAModel
{
 
private:
    DAModel(const DAModel&);
 
    void operator=(const DAModel&);
 
    const fvMesh& mesh_;
 
    const DAOption& daOption_;
 
    label hasTurbulenceModel_ = 0;
 
    label hasRadiationModel_ = 0;
 
public:
    DAModel(
        const fvMesh& mesh,
        const DAOption& daOption);
 
    virtual ~DAModel();
 
    void correctModelStates(wordList& modelStates) const;
 
    void correctStateResidualModelCon(List<List<word>>& stateCon) const;
 
    void addModelResidualCon(HashTable<List<List<word>>>& allCon) const;
 
    void calcResiduals(const dictionary& options);
 
    void correctBoundaryConditions();
 
    void updateIntermediateVariables();
 
    void getTurbProdTerm(volScalarField& prodTerm) const;
 
    void getTurbProdOverDestruct(volScalarField& PoD) const;
 
    void getTurbConvOverProd(volScalarField& CoP) const;
 
    const DATurbulenceModel& getDATurbulenceModel() const;
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //