chombo-discharge
Loading...
Searching...
No Matches
CD_EBHelmholtzRobinEBBCFactory.H
1/*
2 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
3 *
4 * SPDX-License-Identifier: GPL-3.0-or-later
5 */
6
7/*
8 @file CD_EBHelmholtzRobinEBBCFactory.H
9 @brief Declaration of a factory class for making Robin EB boundary conditions with EBHelmholtzOp
10 @author Robert Marskar
11*/
12
13#ifndef CD_EBHELMHOLTZROBINEBBCFACTORY_H
14#define CD_EBHELMHOLTZROBINEBBCFACTORY_H
15
16// Std includes
17#include <functional>
18
19// Our includes
20#include <CD_EBHelmholtzEBBCFactory.H>
21#include <CD_NamespaceHeader.H>
22
30{
31public:
36
45 EBHelmholtzRobinEBBCFactory(const int a_order, const int a_weight, const Real a_A, const Real a_B, const Real a_C);
46
56 const int a_weight,
57 const std::function<Real(const RealVect& a_pos)>& a_A,
58 const std::function<Real(const RealVect& a_pos)>& a_B,
59 const std::function<Real(const RealVect& a_pos)>& a_C);
60
65
70 void
71 setOrder(const int a_order);
72
77 void
78 setWeight(const int a_weight);
79
86 void
87 setCoefficients(const Real a_A, const Real a_B, const Real a_C);
88
95 void
97 const std::function<Real(const RealVect& a_pos)>& a_B,
98 const std::function<Real(const RealVect& a_pos)>& a_C);
99
104 virtual void
106
112 create() override;
113
114protected:
115 /*
116 @brief Use constant for BC
117 */
120
125
130
135
140
145
150
155
160
165
170};
171
172#include <CD_NamespaceFooter.H>
173
174#endif
Factory class for making EBHelmholtzEBBCs.
Definition CD_EBHelmholtzEBBCFactory.H:27
Base class for making Robin boundary conditions with EBHelmholtzOp.
Definition CD_EBHelmholtzRobinEBBCFactory.H:30
void setWeight(const int a_weight)
Set equation weights for least squares reconstruction.
Definition CD_EBHelmholtzRobinEBBCFactory.cpp:72
virtual void setDomainDropOrder(const int a_domainSize)
Drop BC order if domain size is equal or below this.
Definition CD_EBHelmholtzRobinEBBCFactory.cpp:82
Real m_constantA
Constant A-coefficient.
Definition CD_EBHelmholtzRobinEBBCFactory.H:144
bool m_useConstant
Use constant.
Definition CD_EBHelmholtzRobinEBBCFactory.H:119
std::function< Real(const RealVect &a_pos)> m_functionA
Function-based A-coefficient.
Definition CD_EBHelmholtzRobinEBBCFactory.H:159
int m_domainDropOrder
Special flag for dropping stencil order when domains become coarser than this.
Definition CD_EBHelmholtzRobinEBBCFactory.H:139
Real m_constantC
Constant C-coefficient.
Definition CD_EBHelmholtzRobinEBBCFactory.H:154
EBHelmholtzRobinEBBCFactory()
Constructor.
Definition CD_EBHelmholtzRobinEBBCFactory.cpp:18
std::function< Real(const RealVect &a_pos)> m_functionB
Function-based B-coefficient.
Definition CD_EBHelmholtzRobinEBBCFactory.H:164
virtual ~EBHelmholtzRobinEBBCFactory()
Destructor (does nothing).
Definition CD_EBHelmholtzRobinEBBCFactory.cpp:56
void setCoefficients(const Real a_A, const Real a_B, const Real a_C)
Set constant coefficients.
Definition CD_EBHelmholtzRobinEBBCFactory.cpp:90
int m_order
(Attempted) stencil order
Definition CD_EBHelmholtzRobinEBBCFactory.H:129
Real m_constantB
Constant B-coefficient.
Definition CD_EBHelmholtzRobinEBBCFactory.H:149
std::function< Real(const RealVect &a_pos)> m_functionC
Function-based C-coefficient.
Definition CD_EBHelmholtzRobinEBBCFactory.H:169
bool m_useFunction
Use function for BC value.
Definition CD_EBHelmholtzRobinEBBCFactory.H:124
RefCountedPtr< EBHelmholtzEBBC > create() override
Factory method.
Definition CD_EBHelmholtzRobinEBBCFactory.cpp:118
void setOrder(const int a_order)
Set BC order.
Definition CD_EBHelmholtzRobinEBBCFactory.cpp:62
int m_weight
Weight for least squares gradient reconstruction.
Definition CD_EBHelmholtzRobinEBBCFactory.H:134
Base class for a tracer particle solver. This solver can advance particles in a pre-defined velocity ...
Definition CD_TracerParticleSolver.H:38
TracerParticleSolver()
Default constructor.
Definition CD_TracerParticleSolverImplem.H:26