CD_Electrode.H

Go to the documentation of this file.

/* chombo-discharge
 * Copyright © 2021 SINTEF Energy Research.
 * Please refer to Copyright.txt and LICENSE in the chombo-discharge root directory.
 */
 
#ifndef CD_Electrode_H
#define CD_Electrode_H
 
// Chombo includes
#include <BaseIF.H>
#include <RefCountedPtr.H>
 
// Our includes
#include <CD_NamespaceHeader.H>
 
class Electrode
{
public:
  Electrode();
 
  Electrode(const RefCountedPtr<BaseIF>& a_baseIF, const bool a_live, const Real a_voltageFraction = 1.0);
 
  virtual ~Electrode();
 
  virtual void
  define(const RefCountedPtr<BaseIF>& a_baseIF, const bool a_live, const Real a_voltageFraction = 1.0);
 
  virtual const RefCountedPtr<BaseIF>&
  getImplicitFunction() const;
 
  virtual const bool&
  isLive() const;
 
  virtual const Real&
  getFraction() const;
 
protected:
  RefCountedPtr<BaseIF> m_baseIF;
 
  bool m_isLive;
 
  bool m_isDefined;
 
  Real m_voltageFraction;
};
 
#include <CD_NamespaceFooter.H>
 
#endif