Electrode class for encapsulating the concept of an electrical conductor.
More...
#include <CD_Electrode.H>
|
|
| Electrode () |
| | Default constructor. Must subsequently call define()
|
| |
| | Electrode (const RefCountedPtr< BaseIF > &a_baseIF, const bool a_live, const Real a_voltageFraction=1.0) |
| | Constructor.
|
| |
|
virtual | ~Electrode () |
| | Destructor (does nothing)
|
| |
| virtual void | define (const RefCountedPtr< BaseIF > &a_baseIF, const bool a_live, const Real a_voltageFraction=1.0) |
| | Define function.
|
| |
| virtual const RefCountedPtr< BaseIF > & | getImplicitFunction () const |
| | Get implicit function.
|
| |
| virtual const bool & | isLive () const |
| | Get live or not.
|
| |
| virtual const Real & | getFraction () const |
| | Get fraction of live voltage.
|
| |
|
|
RefCountedPtr< BaseIF > | m_baseIF |
| | Implicit function.
|
| |
|
bool | m_isLive |
| | Live or not.
|
| |
|
bool | m_isDefined = false |
| | Is defined or not.
|
| |
|
Real | m_voltageFraction |
| | Fraction of the live potential.
|
| |
Electrode class for encapsulating the concept of an electrical conductor.
◆ Electrode()
| Electrode::Electrode |
( |
const RefCountedPtr< BaseIF > & |
a_baseIF, |
|
|
const bool |
a_live, |
|
|
const Real |
a_voltageFraction = 1.0 |
|
) |
| |
Constructor.
- Parameters
-
| [in] | a_baseIF | Implicit function for the electrode |
| [in] | a_live | Live electrode or not |
| [in] | a_voltageFraction | Fraction of live voltage (if live) |
- Note
- Calls the define function
◆ define()
| void Electrode::define |
( |
const RefCountedPtr< BaseIF > & |
a_baseIF, |
|
|
const bool |
a_live, |
|
|
const Real |
a_voltageFraction = 1.0 |
|
) |
| |
|
virtual |
Define function.
- Parameters
-
| [in] | a_baseIF | Implicit function for the electrode |
| [in] | a_live | Live electrode or not |
| [in] | a_voltageFraction | Fraction of live voltage (if live) |
◆ getFraction()
| const Real & Electrode::getFraction |
( |
| ) |
const |
|
virtual |
Get fraction of live voltage.
- Returns
- m_voltageFraction
◆ getImplicitFunction()
| const RefCountedPtr< BaseIF > & Electrode::getImplicitFunction |
( |
| ) |
const |
|
virtual |
Get implicit function.
- Returns
- Returns m_baseIF
◆ isLive()
| const bool & Electrode::isLive |
( |
| ) |
const |
|
virtual |
Get live or not.
- Returns
- Returns m_isLive
The documentation for this class was generated from the following files:
