Reference system to be used for simpliflying the definition of point positions. More...
#include <ReferenceFrame.h>
Inheritance diagram for XC::ReferenceFrame:
Collaboration diagram for XC::ReferenceFrame:
Public Member Functions | |
| ReferenceFrame (Preprocessor *m) | |
| Constructor. | |
| ReferenceFrame (const std::string &name="", Preprocessor *m=nullptr) | |
| virtual Vector3d | getAxisVDir (const size_t &, const Pos3d &) const =0 |
| Returns the i-th axis unit vector for the position being passed as parameter. More... | |
| Vector3d | getIVector (const Pos3d &) const |
| Return the ${i}$ unit vector expressed in the global coordinate system for the position passed as parameter. More... | |
| Vector3d | getJVector (const Pos3d &) const |
| Return the ${j}$ unit vector expressed in the global coordinate system for the position being passed as parameter. More... | |
| Vector3d | getKVector (const Pos3d &) const |
| Return the ${k}$ unit vector expressed in the global coordinate system for the position being passed as parameter. More... | |
| virtual Pos3d | getGlobalPosition (const Pos3d &p) const =0 |
| Return the global coordinates of point p. | |
| virtual Vector3d | getGlobalCoordinates (const Vector3d &v) const =0 |
| Return the global coordinates of vector v. | |
| virtual Pos3d | getLocalPosition (const Pos3d &p) const =0 |
| Return the local coordinates of point p. | |
| virtual Vector3d | getLocalCoordinates (const Vector3d &v) const =0 |
| Return the local coordinates of vector v. | |
 Public Member Functions inherited from XC::EntMdlrBase | |
| EntMdlrBase (const std::string &nmb="", Preprocessor *preprocessor=nullptr) | |
| Constructor. | |
| EntMdlrBase & | operator+= (const EntMdlrBase &) |
| += operator. | |
| EntMdlrBase & | operator-= (const EntMdlrBase &) |
| -= operator. | |
| EntMdlrBase & | operator*= (const EntMdlrBase &) |
| *= operator (intersection). | |
| virtual bool | operator== (const EntMdlrBase &) const |
| Comparison operator. | |
| const Preprocessor * | getPreprocessor (void) const |
| Return a pointer to the object preprocessor. | |
| Preprocessor * | getPreprocessor (void) |
| Return a pointer to the object preprocessor. | |
| const LabelContainer & | getLabels (void) const |
| size_t | getTag (void) const |
| Return the object identifier in the model (tag). | |
| Pnt * | BuscaPnt (const size_t &) |
| Return a pointer to the point identified by the tag being passed as parameter. More... | |
| const Pnt * | BuscaPnt (const size_t &) const |
| Return a const pointer to the point identified by the tag being passed as parameter. More... | |
| Edge * | BuscaEdge (const size_t &) |
| Return a pointer to the edge identified by the tag being passed as parameter. More... | |
| const Edge * | BuscaEdge (const size_t &) const |
| Return a pointer to the edge identified by the tag being passed as parameter. More... | |
| Face * | BuscaFace (const size_t &) |
| Return a pointer to the face identified by the tag being passed as parameter. More... | |
| const Face * | BuscaFace (const size_t &) const |
| Returns a pointer to the face identified by the tag being passed as parameter. More... | |
| virtual int | sendSelf (Communicator &) |
| Send objects through the communicator argument. | |
| virtual int | recvSelf (const Communicator &) |
| Receive objects through the communicator argument. | |
| boost::python::dict | getPyDict (void) const |
| Return a Python dictionary with the object members values. | |
| void | setPyDict (const boost::python::dict &) |
| Set the values of the object members from a Python dictionary. | |
| Public Member Functions inherited from NamedEntity | |
| NamedEntity (const std::string &Name="", CommandEntity *owr=nullptr) | |
| Constructor. | |
| const std::string & | getName (void) const |
| Return the object name. | |
| void | setName (const std::string &s) |
| Set the object name. | |
| std::string & | Name (void) |
| Return a reference to the object name. | |
| virtual bool | operator== (const NamedEntity &other) const |
| Comparison operator. | |
| bool | operator< (const NamedEntity &other) const |
| Less than operator. | |
| NamedEntity & | operator+= (const NamedEntity &) |
| += operator. | |
| NamedEntity & | operator-= (const NamedEntity &) |
| -= operator. | |
| NamedEntity & | operator*= (const NamedEntity &) |
| *= operator. | |
| boost::python::dict | getPyDict (void) const |
| Return a Python dictionary with the object members values. | |
| void | setPyDict (const boost::python::dict &) |
| Set the values of the object members from a Python dictionary. | |
| Public Member Functions inherited from CommandEntity | |
| CommandEntity (CommandEntity *owr=nullptr) | |
| Default constructor. | |
| CommandEntity * | Owner (void) |
| Return a pointer to the object owner. | |
| const CommandEntity * | Owner (void) const |
| Return un puntero al objeto propietario de ESTE. | |
| const StandardOutputWrapper & | getStandardOutputWrapper (void) const |
| Return the regular output stream wrapper. | |
| StandardOutputWrapper & | getStandardOutputWrapper (void) |
| Return the regular output stream wrapper. | |
| const std::string & | getLogFileName (void) const |
| Returns log file name. | |
| void | setLogFileName (const std::string &) |
| Sets log file name. | |
| const std::string & | getErrFileName (void) const |
| Returns err file name. | |
| void | setErrFileName (const std::string &) |
| Sets error file name. | |
| const std::string & | getOutputFileName (void) const |
| Returns regular output file name. | |
| void | setOutputFileName (const std::string &) |
| Sets regular output file name. | |
| boost::python::object | evalPy (boost::python::object dict, const std::string &) |
| Return the Python object that results from evaluating the argument. | |
| boost::python::object | execPy (boost::python::object dict, const std::string &) |
| Return the Python objects that results from executing the code in the string argument. | |
| boost::python::object | execFilePy (boost::python::object dict, const std::string &) |
| Return the Python object that results from executing the code in the file. | |
| Public Member Functions inherited from EntityWithProperties | |
| EntityWithProperties (EntityWithProperties *owr=nullptr) | |
| Default constructor. | |
| void | clearPyProps (void) |
| Clear python properties map. | |
| bool | hasPyProp (const std::string &) |
| Returns true if property exists. | |
| boost::python::object | getPyProp (const std::string &str) |
| Return the Python object with the name being passed as parameter. | |
| void | setPyProp (std::string str, boost::python::object val) |
| Sets/appends a value tho the Python object's dictionary. | |
| void | copyPropsFrom (const EntityWithProperties &) |
| Copy the properties from the argument. | |
| boost::python::list | getPropNames (void) const |
| Return the names of the object properties weightings. | |
| const PythonDict & | getPropertiesDict (void) const |
| Return a std::map container with the properties of the object. | |
| Public Member Functions inherited from EntityWithOwner | |
| EntityWithOwner (EntityWithOwner *owr=nullptr) | |
| Default constructor. | |
| EntityWithOwner (const EntityWithOwner &) | |
| Copy constructor. | |
| EntityWithOwner & | operator= (const EntityWithOwner &) |
| Assignment operator. | |
| virtual bool | operator== (const EntityWithOwner &) const |
| Comparison operator. | |
| virtual | ~EntityWithOwner (void) |
| Virtual destructor. | |
| virtual std::string | getClassName (void) const |
| Returns demangled class name. | |
| void | set_owner (EntityWithOwner *owr) |
| Assigns the owner of the object. | |
| EntityWithOwner * | Owner (void) |
| const EntityWithOwner * | Owner (void) const |
| Public Member Functions inherited from XC::MovableObject | |
| MovableObject (int classTag, int dbTag) | |
| Constructor. More... | |
| MovableObject (int classTag) | |
| Constructor. More... | |
| MovableObject (const MovableObject &) | |
| Copy constructor. Doesn't copy the dbTag. | |
| MovableObject & | operator= (const MovableObject &) |
| Assignment operator. Doesn't copy the dbTag. | |
| int | getClassTag (void) const |
| Return the class identifier. | |
| int | getDbTag (void) const |
| Return the object identifier in the database. | |
| int | getDbTag (Communicator &) |
| Return the object identifier in the database. | |
| void | setDbTag (int dbTag) |
| Sets the object identifier in the database. | |
| void | setDbTag (Communicator &) |
| Sets the object identifier in the database if not already set. More... | |
| virtual int | setParameter (const std::vector< std::string > &argv, Parameter ¶m) |
Sets the value param to the parameter argv. | |
| virtual int | updateParameter (int parameterID, Information &info) |
Updates the parameter identified by parameterID with info. | |
| virtual int | activateParameter (int parameterID) |
Activates the parameter identified by parameterID. | |
| virtual int | setVariable (const std::string &variable, Information &) |
Set the value of the variable idenfified by var. | |
| virtual int | getVariable (const std::string &variable, Information &) |
Return the value of the variable idenfified by var. | |
| Public Member Functions inherited from XC::DistributedBase | |
| DistributedBase (void) | |
| Constructor. | |
| virtual | ~DistributedBase (void) |
| Destructor. | |
| virtual DbTagData & | getDbTagData (void) const |
| Returns a vector to store class dbTags. | |
| const int & | getDbTagDataPos (const int &i) const |
| Returns the data at the i-th position. | |
| void | setDbTagDataPos (const int &i, const int &v) |
| Sets the data at the i-th position. | |
| void | inicComm (const int &dataSize) const |
| Initializes communication. | |
Additional Inherited Members | |
| Public Types inherited from EntityWithProperties | |
| typedef std::map< std::string, boost::python::object > | PythonDict |
| Static Public Member Functions inherited from CommandEntity | |
| static void | resetStandardOutput (void) |
| Reset the standard output streams to its defaults buffers. | |
| Static Public Member Functions inherited from EntityWithOwner | |
| static int | getVerbosityLevel (void) |
| Get the value of the verbosity level. | |
| static void | setVerbosityLevel (const int &) |
| Set the value of the verbosity level. | |
| Protected Member Functions inherited from XC::EntMdlrBase | |
| bool | check_preprocessor (void) const |
| Check for preprocessor. | |
| int | sendIdsLabels (const int &, const int &, Communicator &) |
| Send labels through the communicator argument. | |
| int | recvIdsLabels (const int &, const int &, const Communicator &) |
| Receive labels through the communicator argument. | |
| int | sendData (Communicator &) |
| Send members through the communicator argument. | |
| int | recvData (const Communicator &) |
| Receive members through the communicator argument. | |
| Protected Member Functions inherited from CommandEntity | |
| template<class T > | |
| void | string_to (T &, const std::string &) const |
| Protected Member Functions inherited from EntityWithProperties | |
| bool | isEqual (const EntityWithProperties &) const |
| Return true if both objects are equal. | |
| Protected Member Functions inherited from EntityWithOwner | |
| virtual bool | isEqual (const EntityWithOwner &) const |
| Return true if both objects are equal. | |
| Static Protected Member Functions inherited from CommandEntity | |
| static CommandEntity * | entcmd_cast (boost::any &data) |
| Protected Attributes inherited from XC::EntMdlrBase | |
| LabelContainer | labels |
| Label container. | |
| Static Protected Attributes inherited from EntityWithOwner | |
| static int | verbosity = 1 |
| Object that owns THIS ONE. More... | |
Detailed Description
Reference system to be used for simpliflying the definition of point positions.
Member Function Documentation
◆ getAxisVDir()
|
pure virtual |
Returns the i-th axis unit vector for the position being passed as parameter.
Implemented in XC::CartesianReferenceFrame3d.
◆ getIVector()
Return the ${i}$ unit vector expressed in the global coordinate system for the position passed as parameter.
◆ getJVector()
Return the ${j}$ unit vector expressed in the global coordinate system for the position being passed as parameter.
◆ getKVector()
Return the ${k}$ unit vector expressed in the global coordinate system for the position being passed as parameter.
The documentation for this class was generated from the following files:
- src/preprocessor/multi_block_topology/ReferenceFrame.h
- src/preprocessor/multi_block_topology/ReferenceFrame.cc
