Solution strategy for the finite element problem. More...

#include <SolutionStrategy.h>

Inheritance diagram for XC::SolutionStrategy:

Collaboration diagram for XC::SolutionStrategy:

Public Member Functions
	SolutionStrategy (SolutionStrategyMap owr=nullptr, ModelWrapper b=nullptr)
	Default constructor.

	SolutionStrategy (const SolutionStrategy &)
	Copy constructor.

SolutionStrategy &	operator= (const SolutionStrategy &)
	Assignment operator.

	~SolutionStrategy (void)
	Destructor.

const SolutionStrategyMap *	getSolutionStrategyMap (void) const
	Returns a pointer to the solution strategy map that contains this object. More...

SolutionStrategyMap *	getSolutionStrategyMap (void)
	Returns a pointer to the solution strategy map that contains this object. More...

const SolutionProcedureControl *	getSolutionProcedureControl (void) const
	Returns a pointer to the solution procedure control object that contains this object. More...

SolutionProcedureControl *	getSolutionProcedureControl (void)
	Returns a pointer to the solution procedure control object that contains this object. More...

std::string	getName (void) const
	Return the name of this object in its container.

const std::string &	getModelWrapperName (void) const
	Return the name of a model wrapper.

ModelWrapper *	getModelWrapperPtr (void)

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 numberer.

AnalysisModel *	getAnalysisModelPtr (void) const
	Returns a pointer to the analysis model.

LinearSOE *	getLinearSOEPtr (void)
	Returns a pointer to the linear system of equations.

const LinearSOE *	getLinearSOEPtr (void) const
	Returns a pointer to the linear system of equations.

EigenSOE *	getEigenSOEPtr (void)
	Returns a pointer to the system of equations de eigenvalues.

const EigenSOE *	getEigenSOEPtr (void) const
	Returns a pointer to the system of equations de eigenvalues.

Integrator &	newIntegrator (const std::string &, const Vector &)
	Defines a new integrator.

Integrator *	getIntegratorPtr (void)
	Returns a pointer to the integrator.

const Integrator *	getIntegratorPtr (void) const

IncrementalIntegrator *	getIncrementalIntegratorPtr (void)
	Returns, if possible, a pointer to the incremental integrator otherwise it returns nullptr. More...

EigenIntegrator *	getEigenIntegratorPtr (void)
	Returns, if possible, a pointer to the eigen integrator otherwise it returns nullptr. More...

LinearBucklingIntegrator *	getLinearBucklingIntegratorPtr (void)
	Returns, if possible, a pointer to the linear buckling integrator otherwise it returns nullptr. More...

TransientIntegrator *	getTransientIntegratorPtr (void)
	Returns, if possible, a pointer to the transient integrator otherwise it returns nullptr. More...

StaticIntegrator *	getStaticIntegratorPtr (void)
	Returns, if possible, a pointer to the static integrator otherwise it returns nullptr. More...

SystemOfEqn &	newSystemOfEqn (const std::string &)
	Sets the system of equations type to use.

SolutionAlgorithm *	getSolutionAlgorithmPtr (void)
	Returns a pointer to the solution algorithm.

const SolutionAlgorithm *	getSolutionAlgorithmPtr (void) const

EigenAlgorithm *	getEigenSolutionAlgorithmPtr (void)
	Returns, if possible, a pointer to the solution algorithm of the eigen problem,, otherwise it returns nullptr. More...

EquiSolnAlgo *	getEquiSolutionAlgorithmPtr (void)
	Returns, if possible, a pointer to the system of equations solution algorithm, otherwise it returns nullptr. More...

DomainDecompAlgo *	getDomainDecompSolutionAlgorithmPtr (void)
	Returns, if possible, a pointer al solution algorithm DomainDecomp , otherwise it returns nullptr. More...

SolutionAlgorithm &	newSolutionAlgorithm (const std::string &)
	Creates a new solution algorithm with the name being passed as parameter.

ConvergenceTest *	getConvergenceTestPtr (void)
	Returns a pointer to the convergence test.

const ConvergenceTest *	getConvergenceTestPtr (void) const
	Returns a pointer to the convergence test.

ConvergenceTest &	newConvergenceTest (const std::string &)
	Set convergence test to be used.

virtual const DomainSolver *	getDomainSolverPtr (void) const
	Returns a pointer to the DomainSolver.

virtual DomainSolver *	getDomainSolverPtr (void)
	Returns a pointer to the DomainSolver.

virtual const Subdomain *	getSubdomainPtr (void) const
	Returns a pointer to the subdomain.

virtual Subdomain *	getSubdomainPtr (void)
	Returns a pointer to the subdomain.

int	setLinearSOE (LinearSOE &theSOE)
	Sets the linear system of equations to use in the analysis.

int	setEigenSOE (EigenSOE &theSOE)
	Sets the eigenSOE to use in the analysis.

int	setIntegrator (Integrator &theNewIntegrator)
	Sets the integrator to use in the analysis.

int	setAlgorithm (SolutionAlgorithm &theNewAlgorithm)
	Sets the solution algorithm to use in the analysis.

int	setConvergenceTest (ConvergenceTest &theNewTest)
	Sets the convergence test to use in the analysis.

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 &)

bool	CheckPointers (void)
	Verifies that the pointers are not null.

void	revertToStart (void)
	Returns the modelo a su estado original.

void	clearAll (void)

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

Protected Member Functions
void	free_soln_algo (void)

bool	alloc_soln_algo (const std::string &)

void	copy_soln_algo (SolutionAlgorithm *)
	To change the algorithm between analysis. More...

void	free_integrator (void)

bool	alloc_integrator (const std::string &, const Vector &)

void	copy_integrator (Integrator *)
	To change the integration scheme between analysis. More...

void	set_integrator (void)
	Informs the analysis object of the new integrator.

void	free_system_of_equations (void)

bool	alloc_system_of_equations (const std::string &, AnalysisModel *)

void	copy_system_of_equations (SystemOfEqn *)
	To change the linear system of equation object between analysis. More...

void	free_conv_test (void)

bool	alloc_conv_test (const std::string &)

void	copy_conv_test (ConvergenceTest *)

void	free_mem (void)

void	copy (const SolutionStrategy &)

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	FEProblem

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

Solution strategy for the finite element problem.

Solution strategy for the finite element problem. The solution strategy is defined by specifying:

Wrapper for the finite element model. Container for the finite element model "as seen" from the solver.
Solution algorithm. An algorithmic class specifying the sequence of operations to be performed in setting up and solving the finite element equation which can be represented by the equation K(U) U = P(U).
Integration scheme. An algorithmic object which provides methods which are invoked by the FE_Element to determine their current tangent and residual matrices; that is this is the object that sets up the system of equations. It also provides the {update()} method which is invoked to set up the appropriate dof response values once the solution algorithm has formed and solved the system of equations.
System of equations. A numeric object responsible for the creation and subsequent solution of large systems of linear equations of the form \(Ax = b\), where \(A\) is a matrix and \(x\) and \(b\) are vectors.
Convergence test.

Member Function Documentation

◆ copy_integrator()

void XC::SolutionStrategy::copy_integrator ( Integrator * ptr )

protected

To change the integration scheme between analysis.

It first invokes the destructor on the old Integrator object associated with the analysis. It then sets the SolutionAlgorithm associated with the analysis to be newAlgorithm and sets the links for this object. It also invokes set_owner().

◆ copy_soln_algo()

void XC::SolutionStrategy::copy_soln_algo ( SolutionAlgorithm * ptr )

protected

To change the algorithm between analysis.

It first invokes the destructor on the old SolutionAlgorithm object associated with the analysis. It then sets the SolutionAlgorithm associated with the analysis to be newAlgorithm and sets the links for this object by invoking set_owner().

◆ copy_system_of_equations()

void XC::SolutionStrategy::copy_system_of_equations ( SystemOfEqn * ptr )

protected

To change the linear system of equation object between analysis.

It first invokes the destructor on the old LinearSOE object associated with the analysis. It then sets the SolutionAlgorithm associated with the analysis to be newSOE. links for this object. It then invokes set_owner().

◆ getDomainDecompSolutionAlgorithmPtr()

XC::DomainDecompAlgo * XC::SolutionStrategy::getDomainDecompSolutionAlgorithmPtr ( void )

Returns, if possible, a pointer al solution algorithm DomainDecomp , otherwise it returns nullptr.

◆ getEigenIntegratorPtr()

XC::EigenIntegrator * XC::SolutionStrategy::getEigenIntegratorPtr ( void )

Returns, if possible, a pointer to the eigen integrator otherwise it returns nullptr.

◆ getEigenSolutionAlgorithmPtr()

XC::EigenAlgorithm * XC::SolutionStrategy::getEigenSolutionAlgorithmPtr ( void )

Returns, if possible, a pointer to the solution algorithm of the eigen problem,, otherwise it returns nullptr.

◆ getEquiSolutionAlgorithmPtr()

XC::EquiSolnAlgo * XC::SolutionStrategy::getEquiSolutionAlgorithmPtr ( void )

Returns, if possible, a pointer to the system of equations solution algorithm, otherwise it returns nullptr.

◆ getIncrementalIntegratorPtr()

XC::IncrementalIntegrator * XC::SolutionStrategy::getIncrementalIntegratorPtr ( void )

Returns, if possible, a pointer to the incremental integrator otherwise it returns nullptr.

◆ getLinearBucklingIntegratorPtr()

XC::LinearBucklingIntegrator * XC::SolutionStrategy::getLinearBucklingIntegratorPtr ( void )

Returns, if possible, a pointer to the linear buckling integrator otherwise it returns nullptr.

◆ getSolutionProcedureControl() [1/2]

const XC::SolutionProcedureControl * XC::SolutionStrategy::getSolutionProcedureControl ( void ) const

Returns a pointer to the solution procedure control object that contains this object.

◆ getSolutionProcedureControl() [2/2]

XC::SolutionProcedureControl * XC::SolutionStrategy::getSolutionProcedureControl ( void )

Returns a pointer to the solution procedure control object that contains this object.

◆ getSolutionStrategyMap() [1/2]

const XC::SolutionStrategyMap * XC::SolutionStrategy::getSolutionStrategyMap ( void ) const

Returns a pointer to the solution strategy map that contains this object.

◆ getSolutionStrategyMap() [2/2]

XC::SolutionStrategyMap * XC::SolutionStrategy::getSolutionStrategyMap ( void )

Returns a pointer to the solution strategy map that contains this object.

◆ getStaticIntegratorPtr()

XC::StaticIntegrator * XC::SolutionStrategy::getStaticIntegratorPtr ( void )

Returns, if possible, a pointer to the static integrator otherwise it returns nullptr.

◆ getTransientIntegratorPtr()

XC::TransientIntegrator * XC::SolutionStrategy::getTransientIntegratorPtr ( void )

Returns, if possible, a pointer to the transient integrator otherwise it returns nullptr.

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

src/solution/SolutionStrategy.h
src/solution/SolutionStrategy.cc

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ copy_integrator()

◆ copy_soln_algo()

◆ copy_system_of_equations()

◆ getDomainDecompSolutionAlgorithmPtr()

◆ getEigenIntegratorPtr()

◆ getEigenSolutionAlgorithmPtr()

◆ getEquiSolutionAlgorithmPtr()

◆ getIncrementalIntegratorPtr()

◆ getLinearBucklingIntegratorPtr()

◆ getSolutionProcedureControl() [1/2]

◆ getSolutionProcedureControl() [2/2]

◆ getSolutionStrategyMap() [1/2]

◆ getSolutionStrategyMap() [2/2]

◆ getStaticIntegratorPtr()

◆ getTransientIntegratorPtr()