The PartitionedModelBuilder class is an abstract class. More...

#include <PartitionedModelBuilder.h>

Inheritance diagram for XC::PartitionedModelBuilder:

Collaboration diagram for XC::PartitionedModelBuilder:

Public Member Functions
	PartitionedModelBuilder (PartitionedDomain &aPartitionedDomain, int classTag)
	Constructor. More...

	PartitionedModelBuilder (Subdomain &aSubdomain, int classTag)
	This is the constructor that is called when a PartitionedModelBuilder is to be created by an FE_ObjectBroker. More...

virtual int	buildFE_Model (void)
	The PartitionedModelBuilder will first check that the PartitionedModelBuilder was constructed with a PartitioneDomain, if not a warning message is printed and a \(-1\) is returned. More...

virtual int	buildInterface (int numSubdomains)=0
	This method must be provided by the subclasses. More...

virtual int	buildSubdomain (int partition, int numPartitions, Subdomain &)=0
	This method must be provided by the subclasses. More...

Public Member Functions inherited from XC::ModelBuilder
	ModelBuilder (Domain &theDomain)
	Constructor. 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

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.

MovableObject &	operator= (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	sendSelf (Communicator &comm)=0
	Send the object. More...

virtual int	recvSelf (const Communicator &comm)=0
	Receive the object. 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 DbTagData &	getDbTagData (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
PartitionedDomain *	getPartitionedDomainPtr (void) const
	Return a pointer to the PartitionedDomain object.

Protected Member Functions inherited from XC::ModelBuilder
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

The PartitionedModelBuilder class is an abstract class.

A subclass of PartitionedModelBuilder is a class which creates a partitioned 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 Subdomains of a PartitionedDomain. PartitionedModelBuilders can be used for creating models for analysis involving domain decomposition methods where there exist natural partitions or where a model has previously been partitioned and this information has been saved.

Constructor & Destructor Documentation

◆ PartitionedModelBuilder() [1/2]

XC::PartitionedModelBuilder::PartitionedModelBuilder	(	PartitionedDomain &	aPartitionedDomain,
		int	theClassTag
	)

Constructor.

Typically, a PartitionedModelBuilder is associated with a PartitionedDomain, this constructor sets up a link for the PartitionedModelBuilder and the domain, setting its link to the Domain object domain. The Domain {domain} is passed to the constructor for ModelBuilder, and the integer classTag is passed to the MovableObject classes constructor.

◆ PartitionedModelBuilder() [2/2]

XC::PartitionedModelBuilder::PartitionedModelBuilder	(	Subdomain &	aSubdomain,
		int	classTag
	)

This is the constructor that is called when a PartitionedModelBuilder is to be created by an FE_ObjectBroker.

The only method that can be invoked on such an object is buildSubdomain().

Parameters

classTag identifier of the class.

Member Function Documentation

◆ buildFE_Model()

int XC::PartitionedModelBuilder::buildFE_Model ( void )

virtual

The PartitionedModelBuilder will first check that the PartitionedModelBuilder was constructed with a PartitioneDomain, if not a warning message is printed and a \(-1\) is returned.

If o.k. the object then determines the number of Subdomains, numSub in the PartitionedDomain. It then invokes {buildInterface(numSub)} on itself. Then for each Subdomain in the PartitionedDomain it invokes {buildSubdomain(numSub, *this)}. If building the interface or any of the subdomains fails, a warning message is printed and a negative number is returned. Returns \(0\) if successful.

Implements XC::ModelBuilder.

◆ buildInterface()

virtual int XC::PartitionedModelBuilder::buildInterface ( int numSubdomains )

pure virtual

This method must be provided by the subclasses.

It is used to add any boundary nodes, nodal loads and constraints to the PartitionedDomain object. The integer numSubdomains is passed to provide information about the number of subdomains in the PartitionedDomain. To return \(0\) if successful, a negative number if not.

◆ buildSubdomain()

virtual int XC::PartitionedModelBuilder::buildSubdomain	(	int	partition,
		int	numPartitions,
		Subdomain &
	)

pure virtual

This method must be provided by the subclasses.

It is used to add nodes, elements, loads and constraints to the subdomain {theSubdomain}. The integers partition and numPartitions are used to identify which partition is being built and the total number of partitions. To return \(0\) if successful, a negative number if not.

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members