Chi-Tech
Public Types | Public Member Functions | Static Public Member Functions | Data Fields
chi_math::UnknownManager Class Reference

#include <unknown_manager.h>

Public Types

typedef std::pair< UnknownType, unsigned int > UnknownInfo
 

Public Member Functions

 UnknownManager (UnknownStorageType in_storage_type=UnknownStorageType::NODAL) noexcept
 
 UnknownManager (std::initializer_list< UnknownInfo > unknown_info_list, UnknownStorageType in_storage_type=UnknownStorageType::NODAL) noexcept
 
 UnknownManager (const std::vector< Unknown > &unknown_info_list, UnknownStorageType in_storage_type=UnknownStorageType::NODAL) noexcept
 
 UnknownManager (std::initializer_list< Unknown > unknowns, UnknownStorageType in_storage_type=UnknownStorageType::NODAL) noexcept
 
 UnknownManager (const UnknownManager &other)=default
 
UnknownManager & operator= (const UnknownManager &other)=default
 
size_t NumberOfUnknowns () const
 
const Unknown & GetUnknown (size_t id) const
 
void SetDOFStorageType (const UnknownStorageType in_storage_type)
 
UnknownStorageType GetDOFStorageType () const
 
void Clear ()
 
unsigned int AddUnknown (UnknownType unk_type, unsigned int dimension=0)
 
unsigned int MapUnknown (unsigned int unknown_id, unsigned int component=0) const
 
unsigned int GetTotalUnknownStructureSize () const
 
void SetUnknownNumOffBlockConnections (unsigned int unknown_id, int num_conn)
 
void SetUnknownComponentNumOffBlockConnections (unsigned int unknown_id, unsigned int component, int num_conn)
 
void SetUnknownTextName (unsigned int unknown_id, const std::string &in_text_name)
 
void SetUnknownComponentTextName (unsigned int unknown_id, unsigned int component, const std::string &in_text_name)
 
 ~UnknownManager ()=default
 

Static Public Member Functions

static UnknownManager GetUnitaryUnknownManager ()
 

Data Fields

std::vector< Unknown > unknowns_
 
UnknownStorageType dof_storage_type_
 

Detailed Description

General object for the management of unknowns in mesh-based mathematical model.

Definition at line 122 of file unknown_manager.h.

Member Typedef Documentation

◆ UnknownInfo

typedef std::pair<UnknownType, unsigned int> chi_math::UnknownManager::UnknownInfo

Definition at line 129 of file unknown_manager.h.

Constructor & Destructor Documentation

◆ UnknownManager() [1/5]

chi_math::UnknownManager::UnknownManager ( UnknownStorageType  in_storage_type = UnknownStorageType::NODAL)
inlineexplicitnoexcept

Definition at line 131 of file unknown_manager.h.

◆ UnknownManager() [2/5]

chi_math::UnknownManager::UnknownManager ( std::initializer_list< UnknownInfo >  unknown_info_list,
UnknownStorageType  in_storage_type = UnknownStorageType::NODAL 
)
inlinenoexcept

Definition at line 137 of file unknown_manager.h.

◆ UnknownManager() [3/5]

chi_math::UnknownManager::UnknownManager ( const std::vector< Unknown > &  unknown_info_list,
UnknownStorageType  in_storage_type = UnknownStorageType::NODAL 
)
inlineexplicitnoexcept

Definition at line 146 of file unknown_manager.h.

◆ UnknownManager() [4/5]

chi_math::UnknownManager::UnknownManager ( std::initializer_list< Unknown >  unknowns,
UnknownStorageType  in_storage_type = UnknownStorageType::NODAL 
)
inlinenoexcept

Definition at line 155 of file unknown_manager.h.

◆ UnknownManager() [5/5]

chi_math::UnknownManager::UnknownManager ( const UnknownManager &  other)
default

◆ ~UnknownManager()

chi_math::UnknownManager::~UnknownManager ( )
default

Member Function Documentation

◆ AddUnknown()

unsigned int chi_math::UnknownManager::AddUnknown ( UnknownType  unk_type,
unsigned int  dimension = 0 
)

Adds an unknown to the manager. This method will figure out where the last unknown ends and where to begin the next one.

Definition at line 9 of file unknown_manager.cc.

◆ Clear()

void chi_math::UnknownManager::Clear ( )
inline

Definition at line 195 of file unknown_manager.h.

◆ GetDOFStorageType()

UnknownStorageType chi_math::UnknownManager::GetDOFStorageType ( ) const
inline

Definition at line 193 of file unknown_manager.h.

◆ GetTotalUnknownStructureSize()

unsigned int chi_math::UnknownManager::GetTotalUnknownStructureSize ( ) const

Determines the total number of components over all unknowns.

Definition at line 89 of file unknown_manager.cc.

◆ GetUnitaryUnknownManager()

static UnknownManager chi_math::UnknownManager::GetUnitaryUnknownManager ( )
inlinestatic

Definition at line 180 of file unknown_manager.h.

◆ GetUnknown()

const Unknown & chi_math::UnknownManager::GetUnknown ( size_t  id) const
inline

Definition at line 186 of file unknown_manager.h.

◆ MapUnknown()

unsigned int chi_math::UnknownManager::MapUnknown ( unsigned int  unknown_id,
unsigned int  component = 0 
) const

Maps the unknown's component within the storage of a node.

Definition at line 73 of file unknown_manager.cc.

◆ NumberOfUnknowns()

size_t chi_math::UnknownManager::NumberOfUnknowns ( ) const
inline

Definition at line 185 of file unknown_manager.h.

◆ operator=()

UnknownManager & chi_math::UnknownManager::operator= ( const UnknownManager &  other)
default

◆ SetDOFStorageType()

void chi_math::UnknownManager::SetDOFStorageType ( const UnknownStorageType  in_storage_type)
inline

Definition at line 188 of file unknown_manager.h.

◆ SetUnknownComponentNumOffBlockConnections()

void chi_math::UnknownManager::SetUnknownComponentNumOffBlockConnections ( unsigned int  unknown_id,
unsigned int  component,
int  num_conn 
)

Sets the number of off block connections for the given unknown- component pair.

Definition at line 120 of file unknown_manager.cc.

◆ SetUnknownComponentTextName()

void chi_math::UnknownManager::SetUnknownComponentTextName ( unsigned int  unknown_id,
unsigned int  component,
const std::string &  in_text_name 
)

Sets the text name to be associated with each component of the unknown.

Definition at line 169 of file unknown_manager.cc.

◆ SetUnknownNumOffBlockConnections()

void chi_math::UnknownManager::SetUnknownNumOffBlockConnections ( unsigned int  unknown_id,
int  num_conn 
)

Sets the number of off block connections for the given unknown. All the components will be set to the same amount.

Definition at line 100 of file unknown_manager.cc.

◆ SetUnknownTextName()

void chi_math::UnknownManager::SetUnknownTextName ( unsigned int  unknown_id,
const std::string &  in_text_name 
)

Sets a text name for the indicated unknown.

Definition at line 149 of file unknown_manager.cc.

Field Documentation

◆ dof_storage_type_

UnknownStorageType chi_math::UnknownManager::dof_storage_type_

Definition at line 127 of file unknown_manager.h.

◆ unknowns_

std::vector<Unknown> chi_math::UnknownManager::unknowns_

Definition at line 126 of file unknown_manager.h.

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