Geophysical Inversion and Modelling Library v1.5.4
Loading...
Searching...
No Matches
GIMLI::ElectrodeShape Class Reference

Abstract class for an electrode with a shape, which is required for modelling. More...

#include <electrode.h>

Inherits GIMLI::Electrode.

Inherited by GIMLI::ElectrodeShapeDomain, GIMLI::ElectrodeShapeEntity, and GIMLI::ElectrodeShapeNode.

+ Collaboration diagram for GIMLI::ElectrodeShape:

Public Member Functions

 ElectrodeShape (const RVector3 &pos)
 
virtual std::vector< MeshEntity * > entities () const
 
virtual double domainSize () const
 
virtual double geomMeanCellAttributes () const
 
virtual double pot (const RVector &sol) const
 
virtual void assembleRHS (RVector &rhs, double value, uint matrixSize) const
 
virtual void setSingValue (RVector &sol, double scale, double k) const
 
void setMID (uint id)
 
virtual int mID () const
 
- Public Member Functions inherited from GIMLI::Electrode
 Electrode ()
 
 Electrode (const RVector3 &pos, int id=-1)
 
 Electrode (double x, double y, double z)
 
 Electrode (const Electrode &el)
 
Electrodeoperator= (const Electrode &el)
 
bool operator== (const Electrode &e) const
 
void setPos (const RVector3 &pos)
 
const RVector3pos () const
 
- Public Member Functions inherited from GIMLI::BaseEntity
 BaseEntity (const BaseEntity &ent)
 
BaseEntityoperator= (const BaseEntity &ent)
 
virtual uint rtti () const
 
virtual bool valid () const
 
virtual void setValid (bool valid)
 
int id () const
 
void setId (int id)
 
void setMarker (int marker)
 
int marker () const
 
void setTagged (bool tagged)
 
void untag ()
 
void tag ()
 
bool tagged () const
 

Protected Attributes

double size_
 size of the domain
 
int mID_
 
- Protected Attributes inherited from GIMLI::Electrode
RVector3 pos_
 
- Protected Attributes inherited from GIMLI::BaseEntity
int id_
 
bool valid_
 
int marker_
 
bool tagged_
 

Detailed Description

Abstract class for an electrode with a shape, which is required for modelling.

Member Function Documentation

◆ assembleRHS()

virtual void GIMLI::ElectrodeShape::assembleRHS ( RVector & rhs,
double value,
uint matrixSize ) const
inlinevirtual

◆ geomMeanCellAttributes()

virtual double GIMLI::ElectrodeShape::geomMeanCellAttributes ( ) const
inlinevirtual

◆ mID()

virtual int GIMLI::ElectrodeShape::mID ( ) const
inlinevirtual

Return matrix ID, i.e. the discrete index within the system of matrix or vector. maybee also dof-position, -1 for unknown.

Referenced by GIMLI::ElectrodeShapeEntity::setSingValue().

◆ pot()

virtual double GIMLI::ElectrodeShape::pot ( const RVector & sol) const
inlinevirtual

Default method to collect to potential value corresponding to this electrode

Reimplemented in GIMLI::ElectrodeShapeDomain, GIMLI::ElectrodeShapeEntity, and GIMLI::ElectrodeShapeNode.

◆ setMID()

void GIMLI::ElectrodeShape::setMID ( uint id)
inline

Sets the position within the system matrix, e.g. the node id for ElectrodeShapeNode.

References GIMLI::BaseEntity::id().

◆ setSingValue()

virtual void GIMLI::ElectrodeShape::setSingValue ( RVector & sol,
double scale,
double k ) const
inlinevirtual

Default method

Reimplemented in GIMLI::ElectrodeShapeEntity, and GIMLI::ElectrodeShapeNode.

Referenced by GIMLI::exactDCSolution().