DAFvSource.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v3
 
    Description:
        Compute the source term (e.g., actuator disk) for the primal 
        governing equations
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAFvSource_H
#define DAFvSource_H
 
#include "runTimeSelectionTables.H"
#include "fvOptions.H"
#include "surfaceFields.H"
#include "DAOption.H"
#include "DAModel.H"
#include "DAIndex.H"
#include "topoSetSource.H"
#include "topoSet.H"
#include "regIOobject.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                    Class DAFvSource Declaration
\*---------------------------------------------------------------------------*/
 
class DAFvSource
    : public regIOobject
{
 
private:
    DAFvSource(const DAFvSource&);
 
    void operator=(const DAFvSource&);
 
protected:
    const word& modelType_;
 
    const fvMesh& mesh_;
 
    const DAOption& daOption_;
 
    const DAModel& daModel_;
 
    const DAIndex& daIndex_;
 
    HashTable<List<scalar>> actuatorDiskDVs_;
 
public:
    TypeName("DAFvSource");
 
    // Declare run-time constructor selection table
    declareRunTimeSelectionTable(
        autoPtr,
        DAFvSource,
        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
    DAFvSource(
        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<DAFvSource> New(
        const word modelType,
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex);
 
    //- Destructor
    virtual ~DAFvSource()
    {
    }
 
    virtual void calcFvSource(volVectorField& fvSource);
 
    void setActuatorDVs(
        const word diskName,
        const label dvI,
        const scalar val)
    {
        actuatorDiskDVs_[diskName][dvI] = val;
    }
 
    scalar getActuatorDVs(
        const word diskName,
        const label dvI)
    {
        return actuatorDiskDVs_[diskName][dvI];
    }
 
    void updateFvSource()
    {
        volVectorField& fvSource = const_cast<volVectorField&>(
            mesh_.thisDb().lookupObject<volVectorField>("fvSource"));
        this->calcFvSource(fvSource);
    }
 
    void syncDAOptionToActuatorDVs();
 
    bool writeData(Ostream& os) const;
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //