wxm::dfem::array::subdomain_array_t Class Reference

The subdomain_array_t class is used to represent a scalar existing on a basis within a portion of the domain (subdomain) More...

#include <subdomain_array.h>

Detailed Description

The subdomain_array_t class is used to represent a scalar existing on a basis within a portion of the domain (subdomain)

Public Types
typedef std::map< int, patch_array_t * >	patch_array_map_t
	Used to store patch arrays.

Public Member Functions
	subdomain_array_t (const WmDomain &domain, const std::string &subdomain_name, bool is_virtual, const WxRange &element_range)
	Constructor.
virtual	~subdomain_array_t ()
	Destructor.
void	fill (const real &value)
	Fill subdomain with a value.
virtual void	dump (WxIoBase &io, WxIoNodeType &group_node, bool include_ghost_elements=false) const
	Write out the array to file.
virtual void	load (WxIoBase &io, const WxIoNodeType &group_node, bool include_ghost_elements=false)
	Load object from file.
patch_array_t &	patch_array (const int patch_index)
	Get the array associated with patch_index.
const patch_array_t &	patch_array (const int patch_index) const
	Get the array associated with patch_index.
const std::string &	name () const
bool	is_virtual () const

Protected Attributes
const WmDomain &	_domain
	Reference to domain object.
std::string	_subdomain_name
	Name of subdomain in mesh.
patch_array_map_t	_patch_array_map
	Collection of patches found in subdomain.
const WxRange &	_element_range
	Range for each element.
WxRange	_global_range
	Global range of array.
int	_mesh_id
	Mesh id.
bool	is_virtual_

Friends
std::ostream &	operator<< (std::ostream &stream, const wxm::dfem::array::subdomain_array_t &array)

Member Typedef Documentation

patch_array_map_t

typedef std::map<int, patch_array_t*> wxm::dfem::array::subdomain_array_t::patch_array_map_t

Used to store patch arrays.

Constructor & Destructor Documentation

subdomain_array_t()

wxm::dfem::array::subdomain_array_t::subdomain_array_t	(	const WmDomain &	domain,
		const std::string &	subdomain_name,
		bool	is_virtual,
		const WxRange &	element_range
	)

Constructor.

Parameters

domain	Domain object
subdomain_name	Name of subdomain
is_virtual	whether this data exists for purely computational reasons (true) or is physically relevant (false)
element_range	Range of each element's dataset

~subdomain_array_t()

virtual wxm::dfem::array::subdomain_array_t::~subdomain_array_t ( )

virtual

Destructor.

Member Function Documentation

dump()

virtual void wxm::dfem::array::subdomain_array_t::dump ( WxIoBase &  io, WxIoNodeType &  group_node, bool  include_ghost_elements = false  ) const

virtual

Write out the array to file.

Parameters

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

fill()

void wxm::dfem::array::subdomain_array_t::fill

(

const real &

value

)

Fill subdomain with a value.

Parameters

value

Value to fill with

is_virtual()

bool wxm::dfem::array::subdomain_array_t::is_virtual ( ) const

inline

load()

virtual void wxm::dfem::array::subdomain_array_t::load ( WxIoBase &  io, const WxIoNodeType &  group_node, bool  include_ghost_elements = false  )

virtual

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
includeGhosts	read external elements

name()

const std::string & wxm::dfem::array::subdomain_array_t::name ( ) const

inline

patch_array() [1/2]

patch_array_t & wxm::dfem::array::subdomain_array_t::patch_array

(

const int

patch_index

)

Get the array associated with patch_index.

Parameters

patch_index

Patch identification index

Returns

Array associated with patch

patch_array() [2/2]

const patch_array_t & wxm::dfem::array::subdomain_array_t::patch_array

(

const int

patch_index

)

const

Get the array associated with patch_index.

Parameters

patch_index

Patch identification index

Returns

Array associated with patch

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  stream, const wxm::dfem::array::subdomain_array_t &  array  )

friend

Member Data Documentation

_domain

const WmDomain& wxm::dfem::array::subdomain_array_t::_domain

protected

Reference to domain object.

_element_range

const WxRange& wxm::dfem::array::subdomain_array_t::_element_range

protected

Range for each element.

_global_range

WxRange wxm::dfem::array::subdomain_array_t::_global_range

protected

Global range of array.

_mesh_id

int wxm::dfem::array::subdomain_array_t::_mesh_id

protected

Mesh id.

_patch_array_map

patch_array_map_t wxm::dfem::array::subdomain_array_t::_patch_array_map

protected

Collection of patches found in subdomain.

_subdomain_name

std::string wxm::dfem::array::subdomain_array_t::_subdomain_name

protected

Name of subdomain in mesh.

is_virtual_

bool wxm::dfem::array::subdomain_array_t::is_virtual_

protected

---

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

• src/dfem/array/subdomain_array.h