DATimeOp.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v4
 
    Description:
        Time operation for functions
 
\*---------------------------------------------------------------------------*/
 
#ifndef DATimeOp_H
#define DATimeOp_H
 
#include "runTimeSelectionTables.H"
#include "fvOptions.H"
#include "DAOption.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                    Class DATimeOp Declaration
\*---------------------------------------------------------------------------*/
 
class DATimeOp
{
 
private:
    DATimeOp(const DATimeOp&);
 
    void operator=(const DATimeOp&);
 
protected:
    const word timeOpType_;
 
    const dictionary options_;
 
public:
    TypeName("DATimeOp");
 
    // Declare run-time constructor selection table
    declareRunTimeSelectionTable(
        autoPtr,
        DATimeOp,
        dictionary,
        (
            const word timeOpType,
            const dictionary options),
        (
            timeOpType,
            options));
 
    // Constructors
 
    //- Construct from components
    DATimeOp(
        const word timeOpType,
        const dictionary options);
 
    // Selectors
 
    //- Return a reference to the selected model
    static autoPtr<DATimeOp> New(
        const word timeOpType,
        const dictionary options);
 
    //- Destructor
    virtual ~DATimeOp()
    {
    }
 
    virtual scalar compute(
        const scalarList& valList,
        const label iStart,
        const label iEnd) = 0;
 
    virtual scalar dFScaling(
        const scalarList& valList,
        const label iStart,
        const label iEnd,
        const label timeIdx) = 0;
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //