HoldsAnodeCathode< Electrode_t > Class Template Reference

Detailed Description

template<class Electrode_t>
class HoldsAnodeCathode< Electrode_t >

An abstract class for objects (problems) that have an anode and a cathode The template argument must be or derive from ElectrodeBase.

Definition at line 42 of file HoldsElectrodes.hpp.

#include <HoldsElectrodes.hpp>

Public Member Functions
	HoldsAnodeCathode ()
	Default constructor. More...
	HoldsAnodeCathode (InputParameters *params, Geometry *geom=nullptr)
	Constructor with parameters, pass geometry to compute measures. More...
	HoldsAnodeCathode (const CepsSet< CepsAttribute > &anodeAttrs, const CepsSet< CepsAttribute > &cathodeAttrs, Geometry *geom=nullptr)
	Constructor with sets of attributes, pass geometry to compute measures. More...
virtual	~HoldsAnodeCathode ()
	Destructor. More...
CepsSet< CepsAttribute > &	getAnodeAttributes () const
	Anode attributes. More...
CepsSet< CepsAttribute > &	getCathodeAttributes () const
	Cathode attributes. More...
void	setElectrodesAttributes (const CepsSet< CepsAttribute > &anodeAttrs, const CepsSet< CepsAttribute > &cathodeAttrs, Geometry *geom=nullptr)
	Sets the attributes. More...
Electrode_t *	getAnode () const
	Ptr to anode object. More...
Electrode_t *	getCathode () const
	Ptr to cathode object. More...

Protected Member Functions
void	checkCommonAttributes ()
	Check that anode and cathode do not share attributes. More...

Protected Attributes
Electrode_t *	m_anode
	Electrode object. More...
Electrode_t *	m_cathode
	Electrode object. More...

Constructor & Destructor Documentation

HoldsAnodeCathode() [1/3]

template<class Electrode_t >

HoldsAnodeCathode< Electrode_t >::HoldsAnodeCathode

Default constructor.

Definition at line 36 of file HoldsElectrodes.cpp.

HoldsAnodeCathode() [2/3]

template<class Electrode_t >

HoldsAnodeCathode< Electrode_t >::HoldsAnodeCathode	(	InputParameters *	params,
		Geometry *	geom = nullptr
	)

Constructor with parameters, pass geometry to compute measures.

Definition at line 43 of file HoldsElectrodes.cpp.

HoldsAnodeCathode() [3/3]

template<class Electrode_t >

HoldsAnodeCathode< Electrode_t >::HoldsAnodeCathode	(	const CepsSet< CepsAttribute > &	anodeAttrs,
		const CepsSet< CepsAttribute > &	cathodeAttrs,
		Geometry *	geom = nullptr
	)

Constructor with sets of attributes, pass geometry to compute measures.

Definition at line 52 of file HoldsElectrodes.cpp.

~HoldsAnodeCathode()

template<class Electrode_t >

HoldsAnodeCathode< Electrode_t >::~HoldsAnodeCathode

virtual

Destructor.

Definition at line 65 of file HoldsElectrodes.cpp.

Member Function Documentation

checkCommonAttributes()

template<class Electrode_t >

void HoldsAnodeCathode< Electrode_t >::checkCommonAttributes

protected

Check that anode and cathode do not share attributes.

Definition at line 118 of file HoldsElectrodes.cpp.

getAnode()

template<class Electrode_t >

Electrode_t * HoldsAnodeCathode< Electrode_t >::getAnode

Ptr to anode object.

Definition at line 104 of file HoldsElectrodes.cpp.

getAnodeAttributes()

template<class Electrode_t >

CepsSet< CepsAttribute > & HoldsAnodeCathode< Electrode_t >::getAnodeAttributes

Anode attributes.

Definition at line 73 of file HoldsElectrodes.cpp.

getCathode()

template<class Electrode_t >

Electrode_t * HoldsAnodeCathode< Electrode_t >::getCathode

Ptr to cathode object.

Definition at line 111 of file HoldsElectrodes.cpp.

getCathodeAttributes()

template<class Electrode_t >

CepsSet< CepsAttribute > & HoldsAnodeCathode< Electrode_t >::getCathodeAttributes

Cathode attributes.

Definition at line 80 of file HoldsElectrodes.cpp.

setElectrodesAttributes()

template<class Electrode_t >

void HoldsAnodeCathode< Electrode_t >::setElectrodesAttributes	(	const CepsSet< CepsAttribute > &	anodeAttrs,
		const CepsSet< CepsAttribute > &	cathodeAttrs,
		Geometry *	geom = nullptr
	)

Sets the attributes.

Definition at line 87 of file HoldsElectrodes.cpp.

Field Documentation

m_anode

template<class Electrode_t >

Electrode_t* HoldsAnodeCathode< Electrode_t >::m_anode

protected

Electrode object.

Definition at line 95 of file HoldsElectrodes.hpp.

m_cathode

template<class Electrode_t >

Electrode_t* HoldsAnodeCathode< Electrode_t >::m_cathode

protected

Electrode object.

Definition at line 96 of file HoldsElectrodes.hpp.

---

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

• /builds/xxjFYZX3/0/carmen/ceps/src/pde/common/electrodes/HoldsElectrodes.hpp
• /builds/xxjFYZX3/0/carmen/ceps/src/pde/common/electrodes/HoldsElectrodes.cpp