Base class for the object that perform the analysis. More...
#include <Analysis.h>
Inheritance diagram for XC::Analysis:
Collaboration diagram for XC::Analysis:
Public Member Functions | |
| SolutionStrategy * | getSolutionStrategyPtr (void) |
| Returns the solution strategy to which this analysis belongs. More... | |
| Domain * | getDomainPtr (void) |
| Returns a pointer to the domain. | |
| const Domain * | getDomainPtr (void) const |
| Returns a pointer to the domain. | |
| ConstraintHandler * | getConstraintHandlerPtr (void) |
| Returns a pointer to the constraint handler. | |
| DOF_Numberer * | getDOF_NumbererPtr (void) const |
| Returns a pointer to the DOF numberer. | |
| AnalysisModel * | getAnalysisModelPtr (void) const |
| Returns a pointer to the analysis model. | |
| LinearSOE * | getLinearSOEPtr (void) const |
| Returns a pointer to the linear system of equations. | |
| EigenSOE * | getEigenSOEPtr (void) const |
| Returns a pointer to the system of equations de eigenvalues. | |
| Integrator * | getIntegratorPtr (void) |
| Returns, if possible, a pointer al integrator otherwise it returns nullptr. | |
| const Integrator * | getIntegratorPtr (void) const |
| Returns, if possible, a pointer al integrator otherwise it returns nullptr. | |
| IncrementalIntegrator * | getIncrementalIntegratorPtr (void) |
| Returns, if possible, a pointer al integrator incremental otherwise it returns nullptr. | |
| EigenIntegrator * | getEigenIntegratorPtr (void) |
| Returns, if possible, a pointer al EigenIntegrator otherwise it returns nullptr. | |
| LinearBucklingIntegrator * | getLinearBucklingIntegratorPtr (void) |
| Returns, if possible, a pointer al LinearBucklingIntegrator otherwise it returns nullptr. | |
| TransientIntegrator * | getTransientIntegratorPtr (void) |
| Returns, if possible, a pointer al EigenIntegrator otherwise it returns nullptr. | |
| StaticIntegrator * | getStaticIntegratorPtr (void) |
| Returns, if possible, a pointer al StaticIntegrator otherwise it returns nullptr. | |
| SolutionAlgorithm * | getSolutionAlgorithmPtr (void) |
| EigenAlgorithm * | getEigenSolutionAlgorithmPtr (void) |
| Return a pointer to the eigenproblem solution algorithm (if it's not defined it returns nullptr). More... | |
| EquiSolnAlgo * | getEquiSolutionAlgorithmPtr (void) |
| Return a pointer to the linear SOE solution algorithm (if it's not defined it returns nullptr). More... | |
| DomainDecompAlgo * | getDomainDecompSolutionAlgorithmPtr (void) |
| Return a pointer to the domain decomposition solution algorithm (if it's not defined it returns nullptr). More... | |
| virtual ConvergenceTest * | getConvergenceTestPtr (void) |
| Returns a pointer to the convergence test (only for suitable analysis). | |
| virtual const ConvergenceTest * | getConvergenceTestPtr (void) const |
| Returns a pointer to the convergence test (only for suitable analysis). | |
| virtual const DomainSolver * | getDomainSolver (void) const |
| Returns a pointer to the DomainSolver. | |
| virtual DomainSolver * | getDomainSolver (void) |
| Returns a pointer to the DomainSolver. | |
| virtual const Subdomain * | getSubdomain (void) const |
| Returns a pointer to the subdomain. | |
| virtual Subdomain * | getSubdomain (void) |
| Returns a pointer to the subdomain. | |
| virtual int | domainChanged (void)=0 |
| virtual void | clearAll (void) |
| Deletes all members (Constraint handler, analysis model,...). | |
| virtual int | setNumberer (DOF_Numberer &theNumberer) |
| Sets the renumerador to use in the analysis. | |
| virtual int | setLinearSOE (LinearSOE &theSOE) |
| Sets the linear system of equations to use in the analysis. | |
| virtual int | setEigenSOE (EigenSOE &theSOE) |
| Sets the system of eigenvalues to use in the analysis. | |
| virtual int | setIntegrator (Integrator &theNewIntegrator) |
| Sets the integrator to use in the analysis. | |
| virtual int | setAlgorithm (SolutionAlgorithm &theNewAlgorithm) |
| Set the solution algorithm to be used in the analysis. | |
| void | brokeConstraintHandler (const Communicator &, const ID &) |
| void | brokeNumberer (const Communicator &, const ID &) |
| void | brokeAnalysisModel (const Communicator &, const ID &) |
| void | brokeDDLinearSOE (const Communicator &, const ID &) |
| void | brokeLinearSOE (const Communicator &, const ID &) |
| void | brokeIncrementalIntegrator (const Communicator &, const ID &) |
| void | brokeStaticIntegrator (const Communicator &, const ID &) |
| void | brokeTransientIntegrator (const Communicator &, const ID &) |
| void | brokeDomainDecompAlgo (const Communicator &, const ID &) |
| void | brokeEquiSolnAlgo (const Communicator &, const ID &) |
| int | getAnalysisResult (void) const |
 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. | |
| virtual bool | operator== (const EntityWithProperties &) const |
| Comparison operator. | |
| 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 |
Protected Member Functions | |
| int | newStepDomain (AnalysisModel *theModel, const double &dT=0.0) |
| SolutionProcedure * | getSolutionProcedure (void) |
| const SolutionProcedure * | getSolutionProcedure (void) const |
| Analysis (SolutionStrategy *analysis_aggregation) | |
| Constructor. More... | |
| virtual Analysis * | getCopy (void) const =0 |
| Virtual constructor. | |
| Protected Member Functions inherited from CommandEntity | |
| template<class T > | |
| void | string_to (T &, const std::string &) const |
Protected Attributes | |
| int | analysis_result |
| Equal to zero if success. | |
| SolutionStrategy * | solution_strategy |
| Solution strategy. | |
Friends | |
| class | SolutionProcedure |
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. | |
| 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
Base class for the object that perform the analysis.
The Analysis class is an abstract base class. Each Analysis object will be associated with a solution method. The owner of the analysis object encloses the domain upon which it will perform the analysis operations. The base Analysis class holds a pointer to this Domain and will return this pointer to subclasses.
Constructor & Destructor Documentation
◆ Analysis()
|
protected |
Constructor.
All analysis are associated with a single solution method, this constructor sets up the link.
- Parameters
-
s solution strategy to which this analysis belongs.
Member Function Documentation
◆ getDomainDecompSolutionAlgorithmPtr()
| XC::DomainDecompAlgo * XC::Analysis::getDomainDecompSolutionAlgorithmPtr | ( | void | ) |
Return a pointer to the domain decomposition solution algorithm (if it's not defined it returns nullptr).
◆ getEigenSolutionAlgorithmPtr()
| XC::EigenAlgorithm * XC::Analysis::getEigenSolutionAlgorithmPtr | ( | void | ) |
Return a pointer to the eigenproblem solution algorithm (if it's not defined it returns nullptr).
◆ getEquiSolutionAlgorithmPtr()
| XC::EquiSolnAlgo * XC::Analysis::getEquiSolutionAlgorithmPtr | ( | void | ) |
Return a pointer to the linear SOE solution algorithm (if it's not defined it returns nullptr).
◆ getSolutionStrategyPtr()
|
inline |
Returns the solution strategy to which this analysis belongs.
The documentation for this class was generated from the following files:
- src/solution/analysis/analysis/Analysis.h
- src/solution/analysis/analysis/Analysis.cpp
