Class for equation numbering. More...

#include <Equations.h>

Collaboration diagram for Equations:

Public Member Functions
	Equations ()
	Default constructor (without parameters).
	Equations (Equations &Instance)
	Copy-initializer constructor. Copies the contents of Instance for the object.
	~Equations ()
	Destructor.
Equations &	operator= (Equations &Instance)
	Copies the contents of Instance for the object.
void	NumberingNodalDOF (FEGroups &Groups, unsigned long TotalNumberNodes, DOFs &DFs, BoundaryConditions &BCs, GeometryMesh &GeoMsh, NodeElementTable &NoElemTable, MeshID_E MeshID)
	Builds the equation numbering.
unsigned long	GetNumberNodalDOFs (unsigned long NodeNumber)
	Returns the number of DOFs of a node.
unsigned long	GetNodalDOFNumbers (unsigned long NodeNumber, unsigned long Cardinality)
	Returns the equation number of a node given the cardinality.
unsigned long *const	GetNodalDOFs (unsigned long NodeNumber, unsigned long &NumberDOFs)
	Returns the equation number of a node and the number of DOFs to a given node.
OneIndexTable< unsigned long > &	GetNodalDOFNumbers ()
	Returns the all equations for each group number.
unsigned long	GetNumberEquations ()
	Returns the numbering of equations.
unsigned long	GetTotalNumberFreeDOFs ()
	Returns the number of equations related to free DOFs.
unsigned long	GetNumberHDBCRestrictedDOFs ()
	Return the number of equations related to the eliminated homogenous dirichlet boundary conditions DOFs.
unsigned long	GetNumberNHDBCRestrictedDOFs ()
	Return the number of equations related to the eliminated non-homogenous dirichlet boundary conditions DOFs.
unsigned long	GetTotalNumberDOFs ()
	Returns the number of equations (DOFs) in the FE model.
unsigned long	GetTotalNumberVertexDOFs ()
	Return the number of equations related to the vertex DOFs.
unsigned long	GetTotalNumberEdgeDOFs ()
	Returns the number of equations related to the edge DOFs.
unsigned long	GetTotalNumberFaceDOFs ()
	Returns the number of equations related to the face DOFs.
unsigned long	GetTotalNumberBodyDOFs ()
	Returns the number of equations related to the body DOFs.
void	SetElementEquations (OneIndexTable< unsigned long > &ElementIncidence, OneIndexTable< unsigned long > &ElementEquations)
	set the element equations.
void	Save (char Tabname, int Version, char Filename)
	Writes class data to a binary database.
void	Save (FILE *File)
	Writes class information to a binary file.
void	Restore (char Tabname, int Version, char Filename)
	Restores class data from a binary database written using the Save method.
void	Restore (FILE *File)
	Restores class data (written using the Save method) from a binary file.
void	Print (FILE File, char Message="")
	Prints the parameters of the Equations to an ASCII file.
void	Free ()
	Releases the physical memory allocated for the groups.
Public Attributes
OneIndexTable< unsigned long >	NodalDOFNumbers
	Table that store for each node the respective dof numbering.
unsigned long	TotalNumDOFs
	Stores the total number of dofs of the FE model.
unsigned long	TotalNumFreeDOFs
	Stores the total number of free dofs.
unsigned long	TotalNumHDBCRestrDOFs
	Stores the total number of restricted dofs of the homogeneous dirichlet boundary condition.
unsigned long	TotalNumNHDBCRestrDOFs
	Stores the total number of restricted dofs of the non-homogeneous dirichlet boundary condition.
unsigned long	NumVertexEquations
	Total number of equations related to vertex nodes.
unsigned long	NumEdgeEquations
	Total number of equations related to edge nodes.
unsigned long	NumFaceEquations
	Total number of equations related to face nodes.
unsigned long	NumBodyEquations
	Total number of equations related to body nodes.

Detailed Description

Class for equation numbering.

Author:: Marco Lcio Bittencourt/ Fabiano Fernandes Bargos

Date:: April/19/2011

Constructor & Destructor Documentation

Equations::Equations ( Equations & Instance )

Copy-initializer constructor. Copies the contents of Instance for the object.

Parameters:

[in] Instance - instance of Equations.

Returns:: Reference to the current object.

Member Function Documentation

unsigned long Equations::GetNodalDOFNumbers	(	unsigned long	NodeNumber,
		unsigned long	Cardinality
	)

Returns the equation number of a node given the cardinality.

Parameters:

[in]	NodeNumber	- global node number.
[in]	Cardinality	- dof cardinality

Returns:: dof number for the given node.

OneIndexTable< unsigned long > & Equations::GetNodalDOFNumbers ( )

Returns the all equations for each group number.

Returns:: OneIndexTable<unsigned long> type.

unsigned long *const Equations::GetNodalDOFs	(	unsigned long	NodeNumber,
		unsigned long &	NumberDOFs
	)

Returns the equation number of a node and the number of DOFs to a given node.

Parameters:

[in]	NodeNumber	- global node number.
[out]	NumberDOFs	- Number of DOFs for the given node.

Returns:: DOFs number for the given node.

unsigned long Equations::GetNumberEquations ( )

Returns the numbering of equations.

Returns:: an unsigned long with the numbering of equations.

unsigned long Equations::GetNumberHDBCRestrictedDOFs ( )

Return the number of equations related to the eliminated homogenous dirichlet boundary conditions DOFs.

Returns:: an unsingned long type with number of equations related to the eliminated HDBC DOFs.

unsigned long Equations::GetNumberNHDBCRestrictedDOFs ( )

Return the number of equations related to the eliminated non-homogenous dirichlet boundary conditions DOFs.

Returns:: an unsingned long type with number of equations related to the eliminated NHDBC DOFs.

unsigned long Equations::GetNumberNodalDOFs ( unsigned long NodeNumber )

Returns the number of DOFs of a node.

Parameters:

[in] NodeNumber - global number of the node.

Returns:: Number of dofs for the given node.

unsigned long Equations::GetTotalNumberBodyDOFs ( )

Returns the number of equations related to the body DOFs.

Returns:: an unsingned long type with the total number of equations related to body nodes.

unsigned long Equations::GetTotalNumberDOFs ( )

Returns the number of equations (DOFs) in the FE model.

Returns:: an unsingned long type with the total number of DOFs.

unsigned long Equations::GetTotalNumberEdgeDOFs ( )

Returns the number of equations related to the edge DOFs.

Returns:: an unsingned long type with the total number of equations related to edge nodes.

unsigned long Equations::GetTotalNumberFaceDOFs ( )

Returns the number of equations related to the face DOFs.

Returns:: an unsingned long type with the total number of equations related to face nodes.

unsigned long Equations::GetTotalNumberFreeDOFs ( )

Returns the number of equations related to free DOFs.

Returns:: an unsingned long type with the total number of free DOFs.

unsigned long Equations::GetTotalNumberVertexDOFs ( )

Return the number of equations related to the vertex DOFs.

Returns:: an unsingned long type with the total number of equations related to vertex nodes.

void Equations::NumberingNodalDOF	(	FEGroups &	Groups,
		unsigned long	TotalNumberNodes,
		DOFs &	DFs,
		BoundaryConditions &	BCs,
		GeometryMesh &	GeoMsh,
		NodeElementTable &	NoElemTable,
		MeshID_E	MeshID
	)

Builds the equation numbering.

Note:: : For while, this code do not is generated because still can not be encoded.

Parameters:

[in]	Groups	- instance of the FEGroups class which stores information for the finite element groups of the discrete model.
[in]	TotalNumberNodes	- total number of mesh nodes.
[in]	DFs	- instance of the DOFs class.
[in]	BCs	- instance of the BoundaryCondictions class.
[in]	GeoMsh	- instance of the GeometryMesh class.
[in]	NoElemTable	- instance of NodeElementTable class.
[in]	MeshID	- Type of mesh.

Equations & Equations::operator= ( Equations & Instance )

Copies the contents of Instance for the object.

Parameters:

[in] Instance - instance of Equations.

Returns:: Reference to the current object.

void Equations::Print	(	FILE *	File,
		char *	Message = `""`
	)

Prints the parameters of the Equations to an ASCII file.

Parameters:

[in]	File	- pointer to the ASCII file.
[in]	Message	- optional message to be written to the ASCII file.

void Equations::Restore	(	char *	Tabname,
		int	Version,
		char *	Filename
	)

Restores class data from a binary database written using the Save method.

Parameters:

[in]	Tabname	- name of the database table where the data will be stored.
[in]	Version	- data version number.
[in]	Filename	- database prefix filename. Two files will be used.

void Equations::Restore ( FILE * File )

Restores class data (written using the Save method) from a binary file.

Parameters:

[in] File - pointer to the binary file.

void Equations::Save	(	char *	Tabname,
		int	Version,
		char *	Filename
	)

Writes class data to a binary database.

Parameters:

[in]	Tabname	- name of the database table where the data will be stored.
[in]	Version	- data version number.
[in]	Filename	- database prefix filename. Two files will be used: filename.dir and filename.bdg. The first one stores keys to the data stored in the filename.bdg file.

void Equations::Save ( FILE * File )

Writes class information to a binary file.

Note:: The current object state can be completely recovered when applying the Restore() operation.

Parameters:

[in] File - pointer to the binary file.

void Equations::SetElementEquations	(	OneIndexTable< unsigned long > &	ElementIncidence,
		OneIndexTable< unsigned long > &	ElementEquations
	)

set the element equations.

Parameters:

[in]	ElementIncidence	- Instance of OneIndexTable to store incidence for each element.
[out]	ElementEquations	- Instance of OneIndexTable to store equations for each element.

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

include/model/Equations.h
src/model/Equations.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation