Electrodes< DIM > Class Template Reference
#include <Electrodes.hpp>
Public Member Functions | |
| Electrodes (TetrahedralMesh< DIM, DIM > &rMesh, bool groundSecondElectrode, unsigned index, double lowerValue, double upperValue, double magnitude, double duration) | |
| ~Electrodes () | |
| BoundaryConditionsContainer < DIM, DIM, 2 > * | GetBoundaryConditionsContainer () |
| bool | SwitchOff (double time) |
Private Attributes | |
| bool | mGroundSecondElectrode |
| BoundaryConditionsContainer < DIM, DIM, 2 > * | mpBoundaryConditionsContainer |
| double | mEndTime |
| bool | mAreActive |
Friends | |
| class | TestBidomainWithBathAssembler |
Detailed Description
template<unsigned DIM>
class Electrodes< DIM >
A class for setting up the boundary conditions associated with electrodes. There are two modes: grounding the second electrode, in which case the first electrode has an input flux (Neumann boundary condition) of the specified magnitude, the extracellular potential is fixed on the second electrode; or not grounded, in which case the opposite electrode has an equal and opposite output flux.This class assumes the given mesh is cuboid, and the electrodes are taken to be the specified opposite surfaces.
Definition at line 49 of file Electrodes.hpp.
Constructor & Destructor Documentation
| Electrodes< DIM >::Electrodes | ( | TetrahedralMesh< DIM, DIM > & | rMesh, | |
| bool | groundSecondElectrode, | |||
| unsigned | index, | |||
| double | lowerValue, | |||
| double | upperValue, | |||
| double | magnitude, | |||
| double | duration | |||
| ) | [inline] |
Constructor. The mesh, assumed to be a cuboid. Whether to ground the second electrode (see class documentation) The value i when applying the electrodes to x_i=a and x_i=b (a<b) The value a when applying the electrodes to x_i=a and x_i=b (a<b) (should be the minimum value of x_i for the given mesh) The value b when applying the electrodes to x_i=a and x_i=b (a<b) (should be the maximum value of x_i for the given mesh) Magnitude of the stimulus Duration of the stimulus. Note, start time currently assumed to be zero.
Definition at line 32 of file Electrodes.cpp.
References BoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::AddDirichletBoundaryCondition(), BoundaryConditionsContainer< ELEM_DIM, SPACE_DIM, PROBLEM_DIM >::AddNeumannBoundaryCondition(), Electrodes< DIM >::mAreActive, Electrodes< DIM >::mEndTime, Electrodes< DIM >::mGroundSecondElectrode, and Electrodes< DIM >::mpBoundaryConditionsContainer.
| Electrodes< DIM >::~Electrodes | ( | ) | [inline] |
Delete the set up bcc
Definition at line 83 of file Electrodes.hpp.
References Electrodes< DIM >::mpBoundaryConditionsContainer.
Member Function Documentation
| BoundaryConditionsContainer<DIM,DIM,2>* Electrodes< DIM >::GetBoundaryConditionsContainer | ( | ) | [inline] |
Get the boundary conditions container in which is set up the Neumann fluxes for the first electrode, and the opposite fluxes for the second electrode if the the second electrode isn't grounded
Definition at line 93 of file Electrodes.hpp.
References Electrodes< DIM >::mAreActive, and Electrodes< DIM >::mpBoundaryConditionsContainer.
| bool Electrodes< DIM >::SwitchOff | ( | double | time | ) | [inline] |
Whether it is time to switch off the electrodes yet. THIS ONLY RETURNS TRUE ONCE - the first appropriate time. After that the electrodes assume they have been switched off and therefore this returns false.
Definition at line 104 of file Electrodes.hpp.
References Electrodes< DIM >::mAreActive, and Electrodes< DIM >::mEndTime.
Member Data Documentation
bool Electrodes< DIM >::mGroundSecondElectrode [private] |
Whether the second electrode is grounded
Definition at line 55 of file Electrodes.hpp.
Referenced by Electrodes< DIM >::Electrodes().
BoundaryConditionsContainer<DIM,DIM,2>* Electrodes< DIM >::mpBoundaryConditionsContainer [private] |
The created bcc, which BidomainProblem will use
Definition at line 57 of file Electrodes.hpp.
Referenced by Electrodes< DIM >::Electrodes(), Electrodes< DIM >::GetBoundaryConditionsContainer(), and Electrodes< DIM >::~Electrodes().
double Electrodes< DIM >::mEndTime [private] |
The time the electrodes are switched off
Definition at line 59 of file Electrodes.hpp.
Referenced by Electrodes< DIM >::Electrodes(), and Electrodes< DIM >::SwitchOff().
bool Electrodes< DIM >::mAreActive [private] |
Whether the electrodes are currently switched on
Definition at line 61 of file Electrodes.hpp.
Referenced by Electrodes< DIM >::Electrodes(), Electrodes< DIM >::GetBoundaryConditionsContainer(), and Electrodes< DIM >::SwitchOff().
The documentation for this class was generated from the following files:
- /tmp/release_1/heart/src/problem/Electrodes.hpp
- /tmp/release_1/heart/src/problem/Electrodes.cpp
