DAResidualDummy.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v3
 
    Description:
        Child class for dummy residual. This child class will do nothing.
        It is useful for initializing other classes
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAResidualDummy_H
#define DAResidualDummy_H
 
#include "DAResidual.H"
#include "addToRunTimeSelectionTable.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
      Class DAResidualDummy Declaration
\*---------------------------------------------------------------------------*/
 
class DAResidualDummy
    : public DAResidual
{
 
protected:
 
public:
    TypeName("dummy");
    // Constructors
 
    //- Construct from components
    DAResidualDummy(
        const word modelType,
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex);
 
    //- Destructor
    virtual ~DAResidualDummy()
    {
    }
 
    // Members
 
    virtual void clear();
 
    virtual void calcResiduals(const dictionary& options);
 
    virtual void updateIntermediateVariables();
 
    virtual void correctBoundaryConditions();
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //