Nektar++
Public Member Functions | List of all members
Nektar::NekMeshUtils::OptiObj Class Reference

#include <OptimiseObj.h>

Inheritance diagram for Nektar::NekMeshUtils::OptiObj:
[legend]

Public Member Functions

 OptiObj ()
 
virtual ~OptiObj ()
 
virtual NekDouble F (Array< OneD, NekDouble > xitst)
 
virtual DNekMat dF (Array< OneD, NekDouble > xitst)
 
virtual Array< OneD, NekDoubleGetxi ()
 
virtual Array< OneD, NekDoubleGetli ()
 
virtual Array< OneD, NekDoubleGetui ()
 
virtual void Update (Array< OneD, NekDouble > xinew)
 

Detailed Description

Definition at line 47 of file OptimiseObj.h.

Constructor & Destructor Documentation

◆ OptiObj()

Nektar::NekMeshUtils::OptiObj::OptiObj ( )
inline

Definition at line 51 of file OptimiseObj.h.

52  {
53  }

◆ ~OptiObj()

virtual Nektar::NekMeshUtils::OptiObj::~OptiObj ( )
inlinevirtual

Definition at line 55 of file OptimiseObj.h.

56  {
57  }

Member Function Documentation

◆ dF()

virtual DNekMat Nektar::NekMeshUtils::OptiObj::dF ( Array< OneD, NekDouble xitst)
inlinevirtual

Reimplemented in Nektar::NekMeshUtils::OptiEdge.

Definition at line 67 of file OptimiseObj.h.

References Nektar::ErrorUtil::efatal, and NEKERROR.

68  {
69  boost::ignore_unused(xitst);
71  "dF() should be implemented in inheriting class");
72  return DNekMat(1,1,0.0);
73  }
#define NEKERROR(type, msg)
Assert Level 0 – Fundamental assert which is used whether in FULLDEBUG, DEBUG or OPT compilation mod...
Definition: ErrorUtil.hpp:209
NekMatrix< NekDouble, StandardMatrixTag > DNekMat
Definition: NekTypeDefs.hpp:51

◆ F()

virtual NekDouble Nektar::NekMeshUtils::OptiObj::F ( Array< OneD, NekDouble xitst)
inlinevirtual

Reimplemented in Nektar::NekMeshUtils::OptiEdge.

Definition at line 59 of file OptimiseObj.h.

References Nektar::ErrorUtil::efatal, and NEKERROR.

60  {
61  boost::ignore_unused(xitst);
63  "F() should be implemented in inheriting class");
64  return 0.0;
65  }
#define NEKERROR(type, msg)
Assert Level 0 – Fundamental assert which is used whether in FULLDEBUG, DEBUG or OPT compilation mod...
Definition: ErrorUtil.hpp:209

◆ Getli()

virtual Array<OneD, NekDouble> Nektar::NekMeshUtils::OptiObj::Getli ( )
inlinevirtual

Reimplemented in Nektar::NekMeshUtils::OptiEdge.

Definition at line 82 of file OptimiseObj.h.

References Nektar::ErrorUtil::efatal, and NEKERROR.

83  {
85  "Getli() should be implemented in inheriting class");
86  return Array<OneD,NekDouble>();
87  }
#define NEKERROR(type, msg)
Assert Level 0 – Fundamental assert which is used whether in FULLDEBUG, DEBUG or OPT compilation mod...
Definition: ErrorUtil.hpp:209

◆ Getui()

virtual Array<OneD, NekDouble> Nektar::NekMeshUtils::OptiObj::Getui ( )
inlinevirtual

Reimplemented in Nektar::NekMeshUtils::OptiEdge.

Definition at line 89 of file OptimiseObj.h.

References Nektar::ErrorUtil::efatal, and NEKERROR.

90  {
92  "Getui() should be implemented in inheriting class");
93  return Array<OneD,NekDouble>();
94  }
#define NEKERROR(type, msg)
Assert Level 0 – Fundamental assert which is used whether in FULLDEBUG, DEBUG or OPT compilation mod...
Definition: ErrorUtil.hpp:209

◆ Getxi()

virtual Array<OneD, NekDouble> Nektar::NekMeshUtils::OptiObj::Getxi ( )
inlinevirtual

Reimplemented in Nektar::NekMeshUtils::OptiEdge.

Definition at line 75 of file OptimiseObj.h.

References Nektar::ErrorUtil::efatal, and NEKERROR.

76  {
78  "Getxi() should be implemented in inheriting class");
79  return Array<OneD,NekDouble>();
80  }
#define NEKERROR(type, msg)
Assert Level 0 – Fundamental assert which is used whether in FULLDEBUG, DEBUG or OPT compilation mod...
Definition: ErrorUtil.hpp:209

◆ Update()

virtual void Nektar::NekMeshUtils::OptiObj::Update ( Array< OneD, NekDouble xinew)
inlinevirtual

Reimplemented in Nektar::NekMeshUtils::OptiEdge.

Definition at line 96 of file OptimiseObj.h.

References Nektar::ErrorUtil::efatal, and NEKERROR.

97  {
98  boost::ignore_unused(xinew);
100  "Update() should be implemented in inheriting class");
101  }
#define NEKERROR(type, msg)
Assert Level 0 – Fundamental assert which is used whether in FULLDEBUG, DEBUG or OPT compilation mod...
Definition: ErrorUtil.hpp:209