DAPartDeriv.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v3
 
    Description:
        Compute partial derivatives using the finite-difference method
        with coloring
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAPartDeriv_H
#define DAPartDeriv_H
 
#include "runTimeSelectionTables.H"
#include "fvOptions.H"
#include "DAUtility.H"
#include "DAOption.H"
#include "DAIndex.H"
#include "DAModel.H"
#include "DAStateInfo.H"
#include "syncTools.H"
#include "DAObjFunc.H"
#include "DAJacCon.H"
#include "DAResidual.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                    Class DAPartDeriv Declaration
\*---------------------------------------------------------------------------*/
 
class DAPartDeriv
{
 
private:
    DAPartDeriv(const DAPartDeriv&);
 
    void operator=(const DAPartDeriv&);
 
protected:
    const word modelType_;
 
    const fvMesh& mesh_;
 
    const DAOption& daOption_;
 
    const DAModel& daModel_;
 
    const DAIndex& daIndex_;
 
    const DAJacCon& daJacCon_;
 
    const DAResidual& daResidual_;
 
    const dictionary& allOptions_;
 
    HashTable<wordList> stateInfo_;
 
    void perturbStates(
        const Vec jacConColors,
        const Vec normStatePerturbVec,
        const label colorI,
        const scalar delta,
        Vec wVec);
 
    void perturbBC(
        const dictionary options,
        const scalar delta);
 
    void setPartDerivMat(
        const Vec resVec,
        const Vec coloredColumn,
        const label transposed,
        Mat jacMat,
        const scalar jacLowerBound=1e-30) const;
    
    void perturbAOA(
        const dictionary options,
        const scalar delta);
 
    Mat dXvdFFDMat_;
 
public:
    TypeName("DAPartDeriv");
 
    // Declare run-time constructor selection table
    declareRunTimeSelectionTable(
        autoPtr,
        DAPartDeriv,
        dictionary,
        (const word modelType,
         const fvMesh& mesh,
         const DAOption& daOption,
         const DAModel& daModel,
         const DAIndex& daIndex,
         const DAJacCon& daJacCon,
         const DAResidual& daResidual),
        (modelType,
         mesh,
         daOption,
         daModel,
         daIndex,
         daJacCon,
         daResidual));
 
    // Constructors
 
    //- Construct from components
    DAPartDeriv(
        const word modelType,
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex,
        const DAJacCon& daJacCon,
        const DAResidual& daResidual);
 
    // Selectors
 
    //- Return a reference to the selected model
    static autoPtr<DAPartDeriv> New(
        const word modelType,
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex,
        const DAJacCon& daJacCon,
        const DAResidual& daResidual);
 
    //- Destructor
    virtual ~DAPartDeriv()
    {
    }
 
    // Member functions
 
    void clear()
    {
        MatDestroy(&dXvdFFDMat_);
    }
 
    virtual void initializePartDerivMat(
        const dictionary& options,
        Mat jacMat) = 0;
 
    virtual void calcPartDerivMat(
        const dictionary& options,
        const Vec xvVec,
        const Vec wVec,
        Mat jacMat) = 0;
 
    void setdXvdFFDMat(const Mat dXvdFFDMat);
 
    void setNormStatePerturbVec(Vec* normStatePerturbVec);
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //