DAFunctionResidualNorm.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v4
 
    Description:
        Child class for residual norm
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAFunctionResidualNorm_H
#define DAFunctionResidualNorm_H
 
#include "DAFunction.H"
#include "addToRunTimeSelectionTable.H"
#include "DAResidual.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
      Class DAFunctionResidualNorm Declaration
\*---------------------------------------------------------------------------*/
 
class DAFunctionResidualNorm
    : public DAFunction
{
 
protected:
    HashTable<scalar> resWeight_;
 
    HashTable<wordList> stateInfo_;
 
public:
    TypeName("residualNorm");
    // Constructors
 
    //- Construct from components
    DAFunctionResidualNorm(
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex,
        const word functionName);
 
    //- Destructor
    virtual ~DAFunctionResidualNorm()
    {
    }
 
    virtual scalar calcFunction();
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //