Homotopy Class Reference
#include <Homotopy.h>
Inheritance diagram for Homotopy:
Public Member Functions | |
Homotopy (HomotopyInput homotopyInput) | |
Homotopy (const char *xmlInputFileName) | |
~Homotopy (void) | |
void | setModel (Model *model) |
set the internally-held pointer to the Model object More... | |
Model * | model (void) |
get the internally-held pointer to the Model object More... | |
const std::string & | type (void) const |
get the type of the model More... | |
int | id (void) const |
get the database id of the model More... | |
int | points (void) const |
get the number of points More... | |
void | execute (void) |
execute the multi-variable homotopy More... | |
Public Member Functions inherited from HomotopyInput | |
HomotopyInput (void) | |
HomotopyInput (std::string type, int id, int points) | |
void | addControlled (const HomotopyVariable &homotopyVariable) |
add controlled variable More... | |
std::string | json (void) const |
Iterator | begin (void) const |
Iterator | end (void) const |
bool | operator== (const HomotopyInput &rhs) const |
Public Member Functions inherited from Diagnostic | |
Diagnostic (void) | |
void | setVerbosity (int verbosity) |
sets the verbosity level for this instance More... | |
int | verbosity (void) const |
Friends | |
std::ostream & | operator<< (std::ostream &os, const Homotopy &homotopy) |
Additional Inherited Members | |
Public Types inherited from HomotopyInput | |
typedef std::vector< HomotopyVariable >::const_iterator | Iterator |
Protected Member Functions inherited from Diagnostic | |
virtual | ~Diagnostic ()=default |
Protected Attributes inherited from HomotopyInput | |
std::string | type_ |
int | id_ |
int | points_ |
std::vector< HomotopyVariable > | controlled_ |
Protected Attributes inherited from Diagnostic | |
int | verbosityInstance |
Detailed Description
for multi-dimensional kernel-side sensitivities constructed from XML file
#include <libpf/core/Homotopy.h>
- Remarks
- Warning
- Thread safe:
- Extendable:
- Platform dependencies:
Constructor & Destructor Documentation
◆ Homotopy() [1/2]
Homotopy::Homotopy | ( | HomotopyInput | homotopyInput | ) |
◆ Homotopy() [2/2]
Homotopy::Homotopy | ( | const char * | xmlInputFileName | ) |
◆ ~Homotopy()
Homotopy::~Homotopy | ( | void | ) |
Member Function Documentation
◆ execute()
void Homotopy::execute | ( | void | ) |
execute the multi-variable homotopy
◆ id()
int Homotopy::id | ( | void | ) | const |
get the database id of the model
◆ model()
◆ points()
int Homotopy::points | ( | void | ) | const |
get the number of points
◆ setModel()
◆ type()
const std::string & Homotopy::type | ( | void | ) | const |
get the type of the model
Friends And Related Function Documentation
◆ operator<<
|
friend |
The documentation for this class was generated from the following file: