Class that defines a structure. More...

#include <structure.hpp>

Detailed Description

template<typename MeshType>
class bem::Structure< MeshType >

Class that defines a structure.

Template Parameters

MeshType - Type of the mesh for representing the structure.

Examples: /examples/ex01_start_here.cpp, and /examples/ex02_assemblers.cpp.

Definition at line 44 of file structure.hpp.

Constructor & Destructor Documentation

◆ Structure() [1/2]

template<typename MeshType >

bem::Structure< MeshType >::Structure ( const Material background_material = PerfectDielectricMaterial(1, 1) )

inline

Constructs an empty Structure.

Parameters

[in] background_material - Background material in which the structure is embedded (optional).

Definition at line 52 of file structure.hpp.

◆ Structure() [2/2]

template<typename MeshType >

bem::Structure< MeshType >::Structure	(	const MeshType &	mesh,
		const Material	background_material = `PerfectDielectricMaterial(1, 1)`
	)

inline

Constructs a Structure with a given mesh.

Parameters

[in]	mesh	- The mesh associated with the structure.
[in]	background_material	- Background material in which the structure is embedded (optional).

Definition at line 62 of file structure.hpp.

Member Function Documentation

◆ add_component()

template<typename MeshType >

void bem::Structure< MeshType >::add_component ( const Component< MeshType > & component )

inline

Adds a component to the structure.

Parameters

[in] component - Component to add.

Definition at line 72 of file structure.hpp.

◆ add_metacomponent()

template<typename MeshType >

void bem::Structure< MeshType >::add_metacomponent ( const Component< MeshType > & metacomponent )

inline

Adds a metaComponent to the structure which corresponds to a given subset of the mesh.

Parameters

[in] metacomponent - Metacomponent to add.

Definition at line 83 of file structure.hpp.

◆ mesh() [1/2]

template<typename MeshType >

MeshType & bem::Structure< MeshType >::mesh ( )

inline

Returns the mesh associated with the structure in editable form.

Returns: Mesh associated with the structure.

Examples: /examples/ex01_start_here.cpp, and /examples/ex02_assemblers.cpp.

Definition at line 94 of file structure.hpp.

◆ mesh() [2/2]

template<typename MeshType >

const MeshType & bem::Structure< MeshType >::mesh ( ) const

inline

Returns the mesh associated with the structure in read-only form.

Returns: Mesh associated with the structure.

Definition at line 102 of file structure.hpp.

◆ background_material()

template<typename MeshType >

const Material & bem::Structure< MeshType >::background_material ( ) const

inline

Returns the background material of the structure.

Returns: Background material of the structure.

Examples: /examples/ex01_start_here.cpp, and /examples/ex02_assemblers.cpp.

Definition at line 110 of file structure.hpp.

◆ components() [1/2]

template<typename MeshType >

std::vector< Component< MeshType > > & bem::Structure< MeshType >::components ( )

inline

Returns an editable list of the components in the structure.

Returns: Components.

Definition at line 118 of file structure.hpp.

◆ components() [2/2]

template<typename MeshType >

const std::vector< Component< MeshType > > & bem::Structure< MeshType >::components ( ) const

inline

Returns a read-only list of the components in the structure.

Returns: Components.

Definition at line 126 of file structure.hpp.

◆ metacomponents() [1/2]

template<typename MeshType >

std::vector< Component< MeshType > > & bem::Structure< MeshType >::metacomponents ( )

inline

Returns an editable list of the metacomponents in the structure.

Returns: Metacomponents.

Definition at line 134 of file structure.hpp.

◆ metacomponents() [2/2]

template<typename MeshType >

const std::vector< Component< MeshType > > & bem::Structure< MeshType >::metacomponents ( ) const

inline

Returns a read-only list of the metacomponents in the structure.

Returns: Metacomponents.

Definition at line 142 of file structure.hpp.

◆ components_by_name()

template<typename MeshType >

std::vector< Component< MeshType > > bem::Structure< MeshType >::components_by_name	(	const std::string	name,
		const bool	search_metacomponents = `false`,
		const bool	case_sensitive = `false`
	)

Returns a list of the components whose name contains a given string.

Parameters

[in]	name	- Search string.
[in]	search_metacomponents	- Whether to search the metacomponents instead of components (optional).
[in]	case_sensitive	- Whether the search should be case sensitive (optional).

Returns: Named components.

Definition at line 32 of file structure.tpp.

◆ mesh_views_by_name()

template<typename MeshType >

std::vector< MeshView< MeshType > > bem::Structure< MeshType >::mesh_views_by_name	(	const std::string	name,
		const bool	search_metacomponents = `false`,
		const bool	case_sensitive = `false`
	)

Returns a list of mesh views associated with components whose name contains a given string.

Parameters

[in]	name	- Search string.
[in]	search_metacomponents	- Whether to search the metacomponents instead of components (optional).
[in]	case_sensitive	- Whether the search should be case sensitive (optional).

Returns: Named mesh views.

Definition at line 67 of file structure.tpp.

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

source/geometry/mesh/mesh_transfer.hpp
source/geometry/structure.hpp
source/geometry/structure.tpp