wxm::dfem::variable::UniqueDistributedComponent Class Reference

Class for Unique Distributed Component. More...

#include <unique_distributed_variable.h>

Detailed Description

Class for Unique Distributed Component.

Public Member Functions
	UniqueDistributedComponent (const WmDomain &domain, const std::vector< std::string > &subdomain_names, const std::vector< std::string > &virtual_subdomains, const WxRange &element_range)
	Constructor.
	~UniqueDistributedComponent ()
	Destructor.
void	fill (const real &value)
	Fill the distributed variable with a value for each component.
wxm::dfem::array::UniquePatchArray &	patch_array (const int patch_index)
	Aquire a patch array for a specified component.
const wxm::dfem::array::UniquePatchArray &	patch_array (const int patch_index) const
	Aquire a patch array for a specified component.
bool	has_patch_array (const int patch_index) const
	Check if patch array exists.
void	dump (WxIoBase &io, WxIoNodeType &group_node) const
	Write out the array to file.
void	load (WxIoBase &io, const WxIoNodeType &group_node)
	Load object from file.
wxm::dfem::array::UniqueSubdomainArray *	get_subdomain_array (const std::string &subdomain)

Protected Types
typedef std::map< int, wxm::dfem::array::UniquePatchArray * >	patch_array_map_t
typedef std::map< std::string, wxm::dfem::array::UniqueSubdomainArray * >	subdomain_arrays_t

Protected Attributes
patch_array_map_t	_patch_array_map
subdomain_arrays_t	_subdomain_arrays
const WmDomain &	_domain
const std::vector< std::string > &	_subdomain_names
const std::vector< std::string > &	_virtual_subdomains
WxRange	_element_range

Member Typedef Documentation

patch_array_map_t

typedef std::map<int, wxm::dfem::array::UniquePatchArray*> wxm::dfem::variable::UniqueDistributedComponent::patch_array_map_t

protected

subdomain_arrays_t

typedef std::map<std::string, wxm::dfem::array::UniqueSubdomainArray*> wxm::dfem::variable::UniqueDistributedComponent::subdomain_arrays_t

protected

Constructor & Destructor Documentation

UniqueDistributedComponent()

wxm::dfem::variable::UniqueDistributedComponent::UniqueDistributedComponent	(	const WmDomain &	domain,
		const std::vector< std::string > &	subdomain_names,
		const std::vector< std::string > &	virtual_subdomains,
		const WxRange &	element_range
	)

Constructor.

~UniqueDistributedComponent()

wxm::dfem::variable::UniqueDistributedComponent::~UniqueDistributedComponent

(

)

Destructor.

Member Function Documentation

dump()

void wxm::dfem::variable::UniqueDistributedComponent::dump	(	WxIoBase &	io,
		WxIoNodeType &	group_node
	)		const

Write out the array to file.

Parameters

io	I/O object to use for writing
grpNode	group node to write to

fill()

void wxm::dfem::variable::UniqueDistributedComponent::fill

(

const real &

value

)

Fill the distributed variable with a value for each component.

Parameters

value

Value to fill component with

get_subdomain_array()

wxm::dfem::array::UniqueSubdomainArray * wxm::dfem::variable::UniqueDistributedComponent::get_subdomain_array

(

const std::string &

subdomain

)

has_patch_array()

bool wxm::dfem::variable::UniqueDistributedComponent::has_patch_array

(

const int

patch_index

)

const

Check if patch array exists.

Parameters

patch_index

Patch of interest

Returns

True if component exists on patch

load()

void wxm::dfem::variable::UniqueDistributedComponent::load	(	WxIoBase &	io,
		const WxIoNodeType &	group_node
	)

Load object from file.

This method is passed a group node from which its data should be read and then constructed.

Parameters

io	I/O object to use for writing
grpNode	group node to read from

patch_array() [1/2]

wxm::dfem::array::UniquePatchArray & wxm::dfem::variable::UniqueDistributedComponent::patch_array

(

const int

patch_index

)

Aquire a patch array for a specified component.

Parameters

component_index	Component of interest
patch_index	Patch of interest

Returns

Array containing patch data

patch_array() [2/2]

const wxm::dfem::array::UniquePatchArray & wxm::dfem::variable::UniqueDistributedComponent::patch_array

(

const int

patch_index

)

const

Aquire a patch array for a specified component.

Parameters

component_index	Component of interest
patch_index	Patch of interest

Returns

Array containing patch data

Member Data Documentation

_domain

const WmDomain& wxm::dfem::variable::UniqueDistributedComponent::_domain

protected

_element_range

WxRange wxm::dfem::variable::UniqueDistributedComponent::_element_range

protected

_patch_array_map

patch_array_map_t wxm::dfem::variable::UniqueDistributedComponent::_patch_array_map

protected

_subdomain_arrays

subdomain_arrays_t wxm::dfem::variable::UniqueDistributedComponent::_subdomain_arrays

protected

_subdomain_names

const std::vector<std::string>& wxm::dfem::variable::UniqueDistributedComponent::_subdomain_names

protected

_virtual_subdomains

const std::vector<std::string>& wxm::dfem::variable::UniqueDistributedComponent::_virtual_subdomains

protected

---

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

• src/dfem/variable/unique_distributed_variable.h