viennashe::she_boundary_conditions_config Class Reference

The boundary condition configuration for SHE
More...

#include <config.hpp>

Public Member Functions
	she_boundary_conditions_config ()
viennashe::boundary_type_id	type () const
	Returns the type of boundary conditions used by SHE. More...
void	type (viennashe::boundary_type_id new_id)
	Setter for the type of boundary conditions used by SHE. More...
double	generation_recombination_rate () const
	Returns the recombination rate used in a Robin boundary condition. More...
void	generation_recombination_rate (double new_tau)
	Sets the recombination rate used in a Robin boundary condition. More...

Detailed Description

The boundary condition configuration for SHE

Definition at line 90 of file config.hpp.

Constructor & Destructor Documentation

she_boundary_conditions_config()

viennashe::she_boundary_conditions_config::she_boundary_conditions_config ( )

inline

Definition at line 93 of file config.hpp.

Member Function Documentation

generation_recombination_rate() [1/2]

double viennashe::she_boundary_conditions_config::generation_recombination_rate ( ) const

inline

Returns the recombination rate used in a Robin boundary condition.

Definition at line 108 of file config.hpp.

generation_recombination_rate() [2/2]

void viennashe::she_boundary_conditions_config::generation_recombination_rate ( double  new_tau )

inline

Sets the recombination rate used in a Robin boundary condition.

Parameters

new_tau

Must be positive and non-negative. Unit: seconds

Definition at line 112 of file config.hpp.

type() [1/2]

viennashe::boundary_type_id viennashe::she_boundary_conditions_config::type ( ) const

inline

Returns the type of boundary conditions used by SHE.

Definition at line 96 of file config.hpp.

type() [2/2]

void viennashe::she_boundary_conditions_config::type ( viennashe::boundary_type_id  new_id )

inline

Setter for the type of boundary conditions used by SHE.

Definition at line 99 of file config.hpp.

---

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

• viennashe/config.hpp