chombo-discharge
Loading...
Searching...
No Matches
CD_DischargeInceptionSpecies.H
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
3 *
4 * SPDX-License-Identifier: GPL-3.0-or-later
5 */
6
13#ifndef CD_DISCHARGEINCEPTIONSPECIES_H
14#define CD_DISCHARGEINCEPTIONSPECIES_H
15
16// Our includes
17#include <CD_CdrSpecies.H>
18#include <CD_NamespaceHeader.H>
19
20namespace Physics {
21 namespace DischargeInception {
22
30 {
31 public:
38 DischargeInceptionSpecies(const std::function<Real(const RealVect& a_pos)>& a_initialData,
39 const bool a_mobile,
40 const bool a_diffusive)
41 {
42 m_initialData = a_initialData;
43 m_isMobile = a_mobile;
44 m_isDiffusive = a_diffusive;
46 m_name = "Ion distribution";
47 }
48
54
61 Real
62 initialData(const RealVect& a_pos, const Real a_time) const override
63 {
64 return m_initialData(a_pos);
65 }
66
67 protected:
71 std::function<Real(const RealVect& a_pos)> m_initialData;
72 };
73 } // namespace DischargeInception
74} // namespace Physics
75
76#include <CD_NamespaceFooter.H>
77
78#endif
Declaration of a class that passes information into CdrSolver (e.g., initial conditions).
Abstract class that describes the scalar quantity that is advected in CdrSolver.
Definition CD_CdrSpecies.H:31
bool m_isMobile
Mobile CdrSpecies or not.
Definition CD_CdrSpecies.H:122
bool m_isDiffusive
Diffusive CdrSpecies or not.
Definition CD_CdrSpecies.H:117
int m_chargeNumber
Charge.
Definition CD_CdrSpecies.H:112
std::string m_name
Cdr_Species name.
Definition CD_CdrSpecies.H:107
CdrSpecies subclass for use with DischargeInceptionStepper.
Definition CD_DischargeInceptionSpecies.H:30
virtual ~DischargeInceptionSpecies()
Destructor.
Definition CD_DischargeInceptionSpecies.H:52
DischargeInceptionSpecies(const std::function< Real(const RealVect &a_pos)> &a_initialData, const bool a_mobile, const bool a_diffusive)
Full constructor.
Definition CD_DischargeInceptionSpecies.H:38
Real initialData(const RealVect &a_pos, const Real a_time) const override
Return the initial species density at the given position.
Definition CD_DischargeInceptionSpecies.H:62
std::function< Real(const RealVect &a_pos)> m_initialData
Callable that maps a position to the initial species density.
Definition CD_DischargeInceptionSpecies.H:71
Namespace containing physics models for use with chombo-discharge.
Definition CD_AdvectionDiffusion.H:16