DAResidual.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v4
 
    Description:
        Compute the residual for a given solver
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAResidual_H
#define DAResidual_H
 
#include "runTimeSelectionTables.H"
#include "fvOptions.H"
#include "surfaceFields.H"
#include "DAOption.H"
#include "DAModel.H"
#include "DAMacroFunctions.H"
#include "DAUtility.H"
#include "DAIndex.H"
#include "DAField.H"
#include "DAFvSource.H"
#include "IOMRFZoneListDF.H"
#include "constrainHbyA.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                    Class DAResidual Declaration
\*---------------------------------------------------------------------------*/
 
class DAResidual
    : public regIOobject
{
 
private:
    DAResidual(const DAResidual&);
 
    void operator=(const DAResidual&);
 
protected:
    const fvMesh& mesh_;
 
    const DAOption& daOption_;
 
    const DAModel& daModel_;
 
    const DAIndex& daIndex_;
 
    DAField daField_;
 
public:
    TypeName("DAResidual");
 
    // Declare run-time constructor selection table
    declareRunTimeSelectionTable(
        autoPtr,
        DAResidual,
        dictionary,
        (const word modelType,
         const fvMesh& mesh,
         const DAOption& daOption,
         const DAModel& daModel,
         const DAIndex& daIndex),
        (modelType, mesh, daOption, daModel, daIndex));
 
    // Constructors
 
    //- Construct from components
    DAResidual(
        const word modelType,
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex);
 
    // Selectors
 
    //- Return a reference to the selected model
    static autoPtr<DAResidual> New(
        const word modelType,
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex);
 
    //- Destructor
    virtual ~DAResidual()
    {
    }
 
    // Members
 
    virtual void clear() = 0;
 
    virtual void calcResiduals(const dictionary& options) = 0;
 
    virtual void updateIntermediateVariables() = 0;
 
    virtual void correctBoundaryConditions() = 0;
 
    void masterFunction(
        const dictionary& options,
        const Vec xvVec,
        const Vec wVec,
        Vec resVec);
 
    virtual void calcPCMatWithFvMatrix(Mat PCMat);
 
    bool writeData(Ostream& os) const
    {
        return true;
    }
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //