Defines data structures for Excitation in swSim. More...
#include "include/Excitation.hpp"
Inheritance diagram for swSim::Excitation:
Classes | |
| struct | excitation_s |
Public Member Functions | |
| Excitation () | |
| Create the Excitation. More... | |
| ~Excitation () | |
| Destroy the Excitation. More... | |
| void | Init (uint32_t id, double *pos, double rad, bool drvn, uint32_t tinit, uint32_t drlen, const char *fname, float *sF, float *orient) |
| Initilize data values. More... | |
| void | Copy (Excitation *other) |
| Copy values of one Excitation to another. More... | |
| MPI_Datatype | MPICreate () |
| Create the MPI datatype for the Excitation. More... | |
| void | ParseSwitch (xmlDocPtr doc, xmlNodePtr cur, int caseNumber) override |
| Provide parsing instructions for reading inputs associated with the Excitation. More... | |
| bool | LocationCheck (std::vector< double > &nCoords) |
 Public Member Functions inherited from swSim::ParsableObject | |
| void | Parse (xmlDocPtr doc, xmlNodePtr cur) |
| Parse the specific object. More... | |
| xmlNodePtr | ParseSearch (xmlDocPtr doc, xmlNodePtr cur, const char *value) |
| Search to the xml element corespondng to each parsable variable. More... | |
| void | Do_parse (xmlDocPtr doc, xmlNodePtr cur, double *value) |
| Parse a double object. More... | |
| void | Do_parse (xmlDocPtr doc, xmlNodePtr cur, float *value) |
| Parse a float object. More... | |
| void | Do_parse (xmlDocPtr doc, xmlNodePtr cur, uint8_t *value) |
| Parse a uint_8 object. More... | |
| void | Do_parse (xmlDocPtr doc, xmlNodePtr cur, uint32_t *value) |
| Parse a uint_32 object. More... | |
| void | Do_parse (xmlDocPtr doc, xmlNodePtr cur, uint64_t *value) |
| Parse a uint_64 object. More... | |
| void | Do_parse (xmlDocPtr doc, xmlNodePtr cur, bool *value) |
| Parse a boolean object. More... | |
| void | Do_parse (xmlDocPtr doc, xmlNodePtr cur, char *value) |
| Parse a char array object. More... | |
Public Attributes | |
| excitation_s | excS |
| Excitation struct. More... | |
| MPI_Datatype | mpi_excitation |
| A MPI_Datatype for the opject. More... | |
| Public Attributes inherited from swSim::ParsableObject | |
| std::vector< std::string > | parseNames |
| Vector of parse names to look for when reading inputs. More... | |
Detailed Description
Defines data structures for Excitation in swSim.
Constructor & Destructor Documentation
◆ Excitation()
| swSim::Excitation::Excitation | ( | ) |
Create the Excitation.
◆ ~Excitation()
| swSim::Excitation::~Excitation | ( | ) |
Destroy the Excitation.
Member Function Documentation
◆ Init()
| void swSim::Excitation::Init | ( | uint32_t | id, |
| double * | pos, | ||
| double | rad, | ||
| bool | drvn, | ||
| uint32_t | tinit, | ||
| uint32_t | drlen, | ||
| const char * | fname, | ||
| float * | sF, | ||
| float * | orient | ||
| ) |
Initilize data values.
◆ Copy()
| void swSim::Excitation::Copy | ( | Excitation * | other | ) |
Copy values of one Excitation to another.
◆ MPICreate()
| MPI_Datatype swSim::Excitation::MPICreate | ( | ) |
Create the MPI datatype for the Excitation.
◆ ParseSwitch()
|
overridevirtual |
Provide parsing instructions for reading inputs associated with the Excitation.
Reimplemented from swSim::ParsableObject.
◆ LocationCheck()
| bool swSim::Excitation::LocationCheck | ( | std::vector< double > & | nCoords | ) |
Member Data Documentation
◆ excS
| excitation_s swSim::Excitation::excS |
Excitation struct.
◆ mpi_excitation
| MPI_Datatype swSim::Excitation::mpi_excitation |
A MPI_Datatype for the opject.
The documentation for this class was generated from the following files:
- include/Excitation.hpp
- src/Excitation.cpp
