xc
Public Member Functions | Protected Member Functions | Friends | List of all members

SubdomainAnalysis is a subclass of AnalysisAnalysis, it is used when performing a domain decomposition analysis. More...

#include <SubdomainAnalysis.h>

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

Public Member Functions

virtual int analyze (void)
 
virtual int domainChanged (void)
 
virtual int getNumExternalEqn (void)
 
virtual int getNumInternalEqn (void)
 
virtual int newStep (double dT)
 
virtual int computeInternalResponse (void)
 
virtual int formTangent (void)
 
virtual int formResidual (void)
 
virtual int formTangVectProduct (Vector &force)
 
virtual const MatrixgetTangent (void)
 
virtual const VectorgetResidual (void)
 
virtual const VectorgetTangVectProduct (void)
 
virtual int sendSelf (Communicator &)
 Send the object. More...
 
virtual int recvSelf (const Communicator &)
 Receive the object. More...
 
- Public Member Functions inherited from XC::Analysis
SolutionStrategygetSolutionStrategyPtr (void)
 Returns the solution strategy to which this analysis belongs. More...
 
DomaingetDomainPtr (void)
 Returns a pointer to the domain.
 
const DomaingetDomainPtr (void) const
 Returns a pointer to the domain.
 
ConstraintHandlergetConstraintHandlerPtr (void)
 Returns a pointer to the constraint handler.
 
DOF_NumberergetDOF_NumbererPtr (void) const
 Returns a pointer to the DOF numberer.
 
AnalysisModelgetAnalysisModelPtr (void) const
 Returns a pointer to the analysis model.
 
LinearSOEgetLinearSOEPtr (void) const
 Returns a pointer to the linear system of equations.
 
EigenSOEgetEigenSOEPtr (void) const
 Returns a pointer to the system of equations de eigenvalues.
 
IntegratorgetIntegratorPtr (void)
 Returns, if possible, a pointer al integrator otherwise it returns nullptr.
 
const IntegratorgetIntegratorPtr (void) const
 Returns, if possible, a pointer al integrator otherwise it returns nullptr.
 
IncrementalIntegratorgetIncrementalIntegratorPtr (void)
 Returns, if possible, a pointer al integrator incremental otherwise it returns nullptr.
 
EigenIntegratorgetEigenIntegratorPtr (void)
 Returns, if possible, a pointer al EigenIntegrator otherwise it returns nullptr.
 
LinearBucklingIntegratorgetLinearBucklingIntegratorPtr (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.
 
StaticIntegratorgetStaticIntegratorPtr (void)
 Returns, if possible, a pointer al StaticIntegrator otherwise it returns nullptr.
 
SolutionAlgorithmgetSolutionAlgorithmPtr (void)
 
EigenAlgorithmgetEigenSolutionAlgorithmPtr (void)
 Return a pointer to the eigenproblem solution algorithm (if it's not defined it returns nullptr). More...
 
EquiSolnAlgogetEquiSolutionAlgorithmPtr (void)
 Return a pointer to the linear SOE solution algorithm (if it's not defined it returns nullptr). More...
 
DomainDecompAlgogetDomainDecompSolutionAlgorithmPtr (void)
 Return a pointer to the domain decomposition solution algorithm (if it's not defined it returns nullptr). More...
 
virtual ConvergenceTestgetConvergenceTestPtr (void)
 Returns a pointer to the convergence test (only for suitable analysis).
 
virtual const ConvergenceTestgetConvergenceTestPtr (void) const
 Returns a pointer to the convergence test (only for suitable analysis).
 
virtual const DomainSolvergetDomainSolver (void) const
 Returns a pointer to the DomainSolver.
 
virtual DomainSolvergetDomainSolver (void)
 Returns a pointer to the DomainSolver.
 
virtual const SubdomaingetSubdomain (void) const
 Returns a pointer to the subdomain.
 
virtual SubdomaingetSubdomain (void)
 Returns a pointer to the subdomain.
 
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.
 
CommandEntityOwner (void)
 Return a pointer to the object owner.
 
const CommandEntityOwner (void) const
 Return un puntero al objeto propietario de ESTE.
 
const StandardOutputWrappergetStandardOutputWrapper (void) const
 Return the regular output stream wrapper.
 
StandardOutputWrappergetStandardOutputWrapper (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.
 
EntityWithOwneroperator= (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.
 
EntityWithOwnerOwner (void)
 
const EntityWithOwnerOwner (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.
 
MovableObjectoperator= (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 &param)
 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 DbTagDatagetDbTagData (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.
 

Protected Member Functions

SubdomaingetSubdomainPtr (void) const
 
DomainSolvergetDomainSolverPtr (void) const
 
 SubdomainAnalysis (Subdomain &theDomain)
 
 SubdomainAnalysis (int classTag, Subdomain &theDomain)
 
 SubdomainAnalysis (Subdomain &theDomain, ConstraintHandler &theHandler, DOF_Numberer &theNumberer, AnalysisModel &theModel, DomainDecompAlgo &theSolnAlgo, IncrementalIntegrator &theIntegrator, LinearSOE &theSOE, DomainSolver &theSolver)
 
AnalysisgetCopy (void) const
 Virtual constructor.
 
- Protected Member Functions inherited from XC::Analysis
int newStepDomain (AnalysisModel *theModel, const double &dT=0.0)
 
SolutionProceduregetSolutionProcedure (void)
 
const SolutionProceduregetSolutionProcedure (void) const
 
 Analysis (SolutionStrategy *analysis_aggregation)
 Constructor. More...
 
- 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.
 

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 CommandEntityentcmd_cast (boost::any &data)
 
- Protected Attributes inherited from XC::Analysis
int analysis_result
 Equal to zero if success.
 
SolutionStrategysolution_strategy
 Solution strategy.
 
- Static Protected Attributes inherited from EntityWithOwner
static int verbosity = 1
 Object that owns THIS ONE. More...
 

Detailed Description

SubdomainAnalysis is a subclass of AnalysisAnalysis, it is used when performing a domain decomposition analysis.

It provides methods which can be invoked by a subdomain to perform the numerical computations required.

Member Function Documentation

◆ recvSelf()

virtual int XC::SubdomainAnalysis::recvSelf ( const Communicator comm)
virtual

Receive the object.

Each object has to receive the data needed to be able to recreate itself in the new process after it has been sent through cp. If the object is an aggregation containing other objects, new objects of the correct type can be constructed using #theBroker. To return 0 if successful or a -1 if not.

Implements XC::MovableObject.

◆ sendSelf()

virtual int XC::SubdomainAnalysis::sendSelf ( Communicator comm)
virtual

Send the object.

Each object has to send the data needed to be able to reproduce that object in a remote process. The object uses the methods provided by cp object to send the data to another channel at the remote actor, the address of the channel is set before this method is called. An object of similar type at the remote actor is invoked with a receiveSelf() to receive the data. Returns 0 if successful (successful in that the data got to the channel), or a - if no data was sent.

Implements XC::MovableObject.


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