Base class for model builders. More...

#include <ModelBuilder.h>

Inheritance diagram for XC::ModelBuilder:

Collaboration diagram for XC::ModelBuilder:

Public Member Functions
	ModelBuilder (Domain &theDomain)
	Constructor. More...

virtual int	buildFE_Model (void)=0
	The ModelBuilder will construct the Element, Node, Load and Constraint objects and add them to the Domain object associated with the ModelBuilder. More...

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
Domain *	getDomainPtr (void) const
	Return a pointer to the domain. More...

Protected Member Functions inherited from CommandEntity
template<class T >
void	string_to (T &, const std::string &) 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.

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 model builders.

The ModelBuilder class is an abstract base class. A subclass of ModelBuilder is a class which creates the finite element discretization of a structure: that is it discretizes the structure to be modeled into Elements, Nodes, Constraints, etc. and adds these components to the Domain.

Constructor & Destructor Documentation

◆ ModelBuilder()

XC::ModelBuilder::ModelBuilder ( Domain & theDomain )

Constructor.

All models are associated with a single domain, this constructor sets up the link between the model and the domain, setting its link to the Domain object theDomain.

Member Function Documentation

◆ buildFE_Model()

virtual int XC::ModelBuilder::buildFE_Model ( void )

pure virtual

The ModelBuilder will construct the Element, Node, Load and Constraint objects and add them to the Domain object associated with the ModelBuilder.

Implemented in XC::PartitionedModelBuilder.

◆ getDomainPtr()

XC::Domain * XC::ModelBuilder::getDomainPtr ( void ) const

protected

Return a pointer to the domain.

Returns a pointer to the Domain object passed in the constructor. This method can be used in the subclasses to get a pointer the Domain object to which to add the domain components.

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

src/domain/domain/subdomain/modelbuilder/ModelBuilder.h
src/domain/domain/subdomain/modelbuilder/ModelBuilder.cpp

Public Member Functions