DAOutput.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v4
 
    Description:
        Assign the output array to the OF variables
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAOutput_H
#define DAOutput_H
 
#include "runTimeSelectionTables.H"
#include "fvOptions.H"
#include "DAOption.H"
#include "DAModel.H"
#include "DAIndex.H"
#include "DAStateInfo.H"
#include "DAFunction.H"
#include "DAResidual.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                    Class DAOutput Declaration
\*---------------------------------------------------------------------------*/
 
class DAOutput
{
 
private:
    DAOutput(const DAOutput&);
 
    void operator=(const DAOutput&);
 
protected:
    const word outputName_;
 
    const word outputType_;
 
    fvMesh& mesh_;
 
    const DAOption& daOption_;
 
    DAModel& daModel_;
 
    const DAIndex& daIndex_;
 
    DAResidual& daResidual_;
 
    UPtrList<DAFunction>& daFunctionList_;
 
    HashTable<wordList> stateInfo_;
 
public:
    TypeName("DAOutput");
 
    // Declare run-time constructor selection table
    declareRunTimeSelectionTable(
        autoPtr,
        DAOutput,
        dictionary,
        (
            const word outputName,
            const word outputType,
            fvMesh& mesh,
            const DAOption& daOption,
            DAModel& daModel,
            const DAIndex& daIndex,
            DAResidual& daResidual,
            UPtrList<DAFunction>& daFunctionList),
        (
            outputName,
            outputType,
            mesh,
            daOption,
            daModel,
            daIndex,
            daResidual,
            daFunctionList));
 
    // Constructors
 
    //- Construct from components
    DAOutput(
        const word outputName,
        const word outputType,
        fvMesh& mesh,
        const DAOption& daOption,
        DAModel& daModel,
        const DAIndex& daIndex,
        DAResidual& daResidual,
        UPtrList<DAFunction>& daFunctionList);
 
    // Selectors
 
    //- Return a reference to the selected model
    static autoPtr<DAOutput> New(
        const word outputName,
        const word outputType,
        fvMesh& mesh,
        const DAOption& daOption,
        DAModel& daModel,
        const DAIndex& daIndex,
        DAResidual& daResidual,
        UPtrList<DAFunction>& daFunctionList);
 
    //- Destructor
    virtual ~DAOutput()
    {
    }
 
    virtual void run(scalarList& output) = 0;
 
    virtual label size() = 0;
 
    virtual label distributed() = 0;
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //