Class that defines a component in a structure. More...

#include <component.hpp>

Detailed Description

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

Class that defines a component in a structure.

Template Parameters

MeshType - Type of the mesh for representing the component.

Definition at line 42 of file component.hpp.

Constructor & Destructor Documentation

◆ Component() [1/2]

template<typename MeshType >

template<typename MaterialType >

bem::Component< MeshType >::Component	(	const MeshView< MeshType > &	mesh_view,
		const MaterialType &	material,
		const std::string	name = `"component"`
	)

inline

Constructs a Component with a mesh view and associated material.

Parameters

[in]	mesh_view	- The mesh view associated with the component.
[in]	material	- Material associated with the component.
[in]	name	- Name of the component (optional).

Definition at line 53 of file component.hpp.

◆ Component() [2/2]

template<typename MeshType >

template<typename MaterialType >

bem::Component< MeshType >::Component	(	const MeshView< MeshType > &	mesh_view,
		const std::string	name = `"component"`
	)

inline

Constructs a Component with a mesh view.

Parameters

[in]	mesh_view	- The mesh view associated with the component.
[in]	name	- Name of the component (optional).

Definition at line 69 of file component.hpp.

Member Function Documentation

◆ mesh_view()

template<typename MeshType >

const MeshView< MeshType > & bem::Component< MeshType >::mesh_view ( ) const

inline

Returns the mesh view associated with the component.

Returns: Mesh view associated with the component.

Definition at line 82 of file component.hpp.

◆ material()

template<typename MeshType >

const Material & bem::Component< MeshType >::material ( ) const

inline

Returns the material associated with the component.

Returns: Material associated with the component.

Definition at line 90 of file component.hpp.

◆ mesh()

template<typename MeshType >

MeshType bem::Component< MeshType >::mesh ( ) const

inline

Returns the mesh associated with the component.

Returns: Mesh associated with the component.

Definition at line 98 of file component.hpp.

◆ name()

template<typename MeshType >

const std::string & bem::Component< MeshType >::name ( ) const

inline

Returns the name of the component.

Returns: Name of the component.

Definition at line 106 of file component.hpp.

◆ set_material()

template<typename MeshType >

template<typename MaterialType >

void bem::Component< MeshType >::set_material ( const MaterialType & material )

inline

Sets the material of the component.

Parameters

[in] material - Material to set for the component.

Definition at line 114 of file component.hpp.

◆ set_name()

template<typename MeshType >

void bem::Component< MeshType >::set_name ( const std::string & name )

inline

Sets the name of the component.

Parameters

[in] name - Name to set for the component.

Definition at line 122 of file component.hpp.

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

source/geometry/component.hpp