DAField.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v4
 
    Description:
        Field manipulation such as correct boundary conditions
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAField_H
#define DAField_H
 
#include "fvOptions.H"
#include "surfaceFields.H"
#include "DAOption.H"
#include "DAUtility.H"
#include "DAStateInfo.H"
#include "DAModel.H"
#include "DAIndex.H"
#include "DAMacroFunctions.H"
#include "mixedFvPatchFields.H" // for setPrimalBoundaryCondition
#include "fixedGradientFvPatchField.H" // for setPrimalBoundaryCondition
#include "wordRe.H"
#include "wordRes.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                       Class DAField Declaration
\*---------------------------------------------------------------------------*/
 
class DAField
{
 
private:
    DAField(const DAField&);
 
    void operator=(const DAField&);
 
protected:
    const fvMesh& mesh_;
 
    const DAOption& daOption_;
 
    const DAModel& daModel_;
 
    const DAIndex& daIndex_;
 
    HashTable<wordList> stateInfo_;
 
public:
    DAField(
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex);
 
    virtual ~DAField()
    {
    }
 
    // Members
 
    void ofField2StateVec(Vec stateVec) const;
 
    void stateVec2OFField(const Vec stateVec) const;
 
    void state2OFField(const scalar* states) const;
 
    void ofField2State(scalar* states) const;
 
    void point2OFMesh(const scalar* volCoords) const;
 
    void ofMesh2PointVec(Vec xvVec) const;
 
    void ofResField2ResVec(Vec resVec) const;
 
    void setPrimalBoundaryConditions(const label printInfo = 1);
 
    void specialBCTreatment();
 
    void checkSpecialBCs();
 
    wordList specialBCs;
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //