DAStateInfo.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v3
 
    Description:
        Register the names of state variables and how do they connect
        with their residuals
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAStateInfo_H
#define DAStateInfo_H
 
#include "runTimeSelectionTables.H"
#include "fvOptions.H"
#include "surfaceFields.H"
#include "DAOption.H"
#include "DAModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                    Class DAStateInfo Declaration
\*---------------------------------------------------------------------------*/
 
class DAStateInfo
{
 
private:
    DAStateInfo(const DAStateInfo&);
 
    void operator=(const DAStateInfo&);
 
protected:
    const fvMesh& mesh_;
 
    const DAOption& daOption_;
 
    const DAModel& daModel_;
 
    HashTable<wordList> stateInfo_;
 
    HashTable<List<List<word>>> stateResConInfo_;
 
public:
    TypeName("DAStateInfo");
 
    // Declare run-time constructor selection table
    declareRunTimeSelectionTable(
        autoPtr,
        DAStateInfo,
        dictionary,
        (const word modelType,
         const fvMesh& mesh,
         const DAOption& daOption,
         const DAModel& daModel),
        (modelType, mesh, daOption, daModel));
 
    // Constructors
 
    //- Construct from components
    DAStateInfo(
        const word modelType,
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel);
 
    // Selectors
 
    //- Return a reference to the selected model
    static autoPtr<DAStateInfo> New(
        const word modelType,
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel);
 
    //- Destructor
    virtual ~DAStateInfo()
    {
    }
 
    const HashTable<wordList>& getStateInfo() const
    {
        return stateInfo_;
    }
 
    const HashTable<List<List<word>>>& getStateResConInfo() const
    {
        return stateResConInfo_;
    }
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //