doxygen/html/CD__ElectrostaticEbBc_8H_source.html

 /* chombo-discharge

  * Copyright © 2021 SINTEF Energy Research.

  * Please refer to Copyright.txt and LICENSE in the chombo-discharge root directory.

  */


 #ifndef CD_ElectrostaticEbBc_H

 #define CD_ElectrostaticEbBc_H


 // Std includes

 #include <functional>

 #include <vector>


 // Chombo includes

 #include <RealVect.H>


 // Our includes

 #include <CD_Electrode.H>

 #include <CD_NamespaceHeader.H>


 class ElectrostaticEbBc

 {

 public:

   using BcFunction = std::function<Real(const RealVect a_position, const Real a_time)>;


   ElectrostaticEbBc();


   virtual ~ElectrostaticEbBc();


   void

   clear();


   void

   addEbBc(const Electrode& a_electrode, const BcFunction& a_bcFunction);


   void

   setEbBc(const int a_electrode, const BcFunction& a_bcFunction);


   BcFunction&

   getBc(const int a_electrode);


   const BcFunction&

   getBc(const int a_electrode) const;


   std::vector<std::pair<Electrode, BcFunction>>&

   getBcs();


   const std::vector<std::pair<Electrode, BcFunction>>&

   getBcs() const;


 protected:

   std::vector<std::pair<Electrode, BcFunction>> m_bcFunctions;

 };


 #include <CD_NamespaceFooter.H>


 #endif

CD_Electrode.H
Declaration of an electrode class.

Electrode
Electrode class for encapsulating the concept of an electrical conductor.
Definition: CD_Electrode.H:26

ElectrostaticEbBc
Class which maps boundary condition types to a side and direction.
Definition: CD_ElectrostaticEbBc.H:33

ElectrostaticEbBc::BcFunction
std::function< Real(const RealVect a_position, const Real a_time)> BcFunction
Function which maps f(R^3,t) : R. Used for setting the potential at an electrode.
Definition: CD_ElectrostaticEbBc.H:38

ElectrostaticEbBc::setEbBc
void setEbBc(const int a_electrode, const BcFunction &a_bcFunction)
Set the potential for a_electrode to be given by a_bcFunction.
Definition: CD_ElectrostaticEbBc.cpp:43

ElectrostaticEbBc::addEbBc
void addEbBc(const Electrode &a_electrode, const BcFunction &a_bcFunction)
Add a boundary condition.
Definition: CD_ElectrostaticEbBc.cpp:35

ElectrostaticEbBc::ElectrostaticEbBc
ElectrostaticEbBc()
Initializing constructor (does nothing)
Definition: CD_ElectrostaticEbBc.cpp:16

ElectrostaticEbBc::~ElectrostaticEbBc
virtual ~ElectrostaticEbBc()
Destructor (does nothing)
Definition: CD_ElectrostaticEbBc.cpp:21

ElectrostaticEbBc::m_bcFunctions
std::vector< std::pair< Electrode, BcFunction > > m_bcFunctions
Data structure which holds electrode and associated potential functions.
Definition: CD_ElectrostaticEbBc.H:108

ElectrostaticEbBc::getBc
BcFunction & getBc(const int a_electrode)
Return boundary condition associated with a particular electrode.
Definition: CD_ElectrostaticEbBc.cpp:55

ElectrostaticEbBc::getBcs
std::vector< std::pair< Electrode, BcFunction > > & getBcs()
Get all boundary conditions.
Definition: CD_ElectrostaticEbBc.cpp:79

ElectrostaticEbBc::clear
void clear()
Clears the object.
Definition: CD_ElectrostaticEbBc.cpp:27