xc
Public Member Functions | List of all members
XC::SolutionProcedureControl Class Reference

Container for the objects that control the solution procedure. More...

#include <SolutionProcedureControl.h>

Inheritance diagram for XC::SolutionProcedureControl:
Inheritance graph
[legend]
Collaboration diagram for XC::SolutionProcedureControl:
Collaboration graph
[legend]

Public Member Functions

 SolutionProcedureControl (SolutionProcedure *owr)
 Default constructor.
 
Domain * getDomain (void)
 Return a pointer to the domain on which the solution algorithm operates. More...
 
const Domain * getDomain (void) const
 Return a pointer to the domain on which the solution algorithm operates. More...
 
Analysis * getAnalysis (void)
 Return a pointer to the analysis on which the solution algorithm operates. More...
 
const Analysis * getAnalysis (void) const
 Return a pointer to the analysis on which the solution algorithm operates. More...
 
Integrator * getIntegratorPtr (void)
 Return a pointer to the integrator.
 
const Integrator * getIntegratorPtr (void) const
 Return a const pointer to the integrator.
 
DataOutputHandler::map_output_handlers * getOutputHandlers (void) const
 
const ModelWrapper * getModelWrapper (const std::string &) const
 Return a pointer to the model wrapper with the identifier being passed as parameter. More...
 
ModelWrapper * getModelWrapper (const std::string &)
 Return a pointer to the model wrapper with the identifier passed as parameter. More...
 
const std::string & getModelWrapperName (const ModelWrapper *) const
 Return the name of a model wrapper.
 
const SolutionStrategy * getSolutionStrategy (const std::string &) const
 Return a const pointer to the solution method.
 
SolutionStrategy * getSolutionStrategy (const std::string &)
 Return a const pointer to the solution method.
 
MapModelWrapper & getModelWrapperContainer (void)
 Return a reference to the model wrapper container.
 
SolutionStrategyMap & getSolutionStrategyContainer (void)
 Return a reference to the solution procedures container.
 
void revertToStart (void)
 Revert to the initial state.
 
void clearAll (void)
 Clear all.
 
- 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.
 
boost::python::dict getPyDict (void) const
 Return a Python dictionary containing 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 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
 

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 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)
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

Detailed Description

Container for the objects that control the solution procedure.

Member Function Documentation

◆ getAnalysis() [1/2]

XC::Analysis * XC::SolutionProcedureControl::getAnalysis ( void  )

Return a pointer to the analysis on which the solution algorithm operates.

◆ getAnalysis() [2/2]

const XC::Analysis * XC::SolutionProcedureControl::getAnalysis ( void  ) const

Return a pointer to the analysis on which the solution algorithm operates.

◆ getDomain() [1/2]

XC::Domain * XC::SolutionProcedureControl::getDomain ( void  )

Return a pointer to the domain on which the solution algorithm operates.

◆ getDomain() [2/2]

const XC::Domain * XC::SolutionProcedureControl::getDomain ( void  ) const

Return a pointer to the domain on which the solution algorithm operates.

◆ getModelWrapper() [1/2]

const XC::ModelWrapper * XC::SolutionProcedureControl::getModelWrapper ( const std::string &  cod) const

Return a pointer to the model wrapper with the identifier being passed as parameter.

◆ getModelWrapper() [2/2]

XC::ModelWrapper * XC::SolutionProcedureControl::getModelWrapper ( const std::string &  cod)

Return a pointer to the model wrapper with the identifier passed as parameter.


The documentation for this class was generated from the following files: