DAFunctionLocation.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v4
 
    Description:
        Child class for location of a select patch, e.g., maxRadius
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAFunctionLocation_H
#define DAFunctionLocation_H
 
#include "DAFunction.H"
#include "addToRunTimeSelectionTable.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
      Class DAFunctionLocation Declaration
\*---------------------------------------------------------------------------*/
 
class DAFunctionLocation
    : public DAFunction
{
 
protected:
    scalar coeffKS_ = 1.0;
 
    word mode_;
 
    vector axis_ = {1, 0, 0};
 
    vector center_ = {0, 0, 0};
 
    label maxRPatchI_ = -1;
 
    label maxRFaceI_ = -1;
 
    label snapCenter2Cell_ = 0;
 
    label snappedCenterCellI_ = -1;
 
public:
    TypeName("location");
    // Constructors
 
    //- Construct from components
    DAFunctionLocation(
        const fvMesh& mesh,
        const DAOption& daOption,
        const DAModel& daModel,
        const DAIndex& daIndex,
        const word functionName);
 
    //- Destructor
    virtual ~DAFunctionLocation()
    {
    }
 
    virtual scalar calcFunction();
 
    void findGlobalSnappedCenter(
        label snappedCenterCellI,
        vector& center);
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //