Block-Structured AMR Software Framework
Loading...
Searching...
No Matches
AMReX_MLTensorOp.H
Go to the documentation of this file.
1#ifndef AMREX_ML_TENSOR_OP_H_
2#define AMREX_ML_TENSOR_OP_H_
3#include <AMReX_Config.H>
4
6#include <AMReX_Array.H>
7
8// Feature macro: when defined, MLTensorOp::setMappingFactors exists and the
9// cross-term (transpose and bulk) fluxes honour a diagonal mesh mapping.
10#define AMREX_MLTENSOROP_HAS_MAPPING_FACTORS 1
11
12namespace amrex {
13
19
20// Tensor solver for high Reynolds flows with small gradient in viscosity.
21// The system it solves is
22//
23// alpha a v - beta div dot tau = rhs
24//
25// where tau = eta [grad v + (grad v)^T] + (kappa-(2/3)eta) (div v) I.
26// Here eta and kappa are shear and bulk viscosity, and I is identity tensor.
27//
28// The user needs to provide `a` by `setACoeffs`, eta by `setShearViscosity`,
29// and kappa by `setBulkViscosity`. If `setBulkViscosity` is not called,
30// kappa is set to zero.
31//
32// The scalars alpha and beta can be set with `setScalars(Real, Real)`. If
33// they are not set, their default value is 1.
34
36template <typename MF>
38 : public MLABecLaplacianT<MF>
39{
40public:
41
42 using FAB = typename MF::fab_type;
43 using RT = typename MF::value_type;
45 using BCMode = typename MLLinOpT<MF>::BCMode;
47
56 const Vector<BoxArray>& a_grids,
57 const Vector<DistributionMapping>& a_dmap,
58 const LPInfo& a_info = LPInfo(),
59 const Vector<FabFactory<FAB> const*>& a_factory = {});
64 const Vector<BoxArray>& a_grids,
65 const Vector<DistributionMapping>& a_dmap,
66 const Vector<iMultiFab const*>& a_overset_mask, // 1: unknown, 0: known
67 const LPInfo& a_info = LPInfo(),
68 const Vector<FabFactory<FAB> const*>& a_factory = {});
69 ~MLTensorOpT () override = default;
70
71 MLTensorOpT (const MLTensorOpT&) = delete;
75
85 void define (const Vector<Geometry>& a_geom,
86 const Vector<BoxArray>& a_grids,
87 const Vector<DistributionMapping>& a_dmap,
88 const LPInfo& a_info = LPInfo(),
89 const Vector<FabFactory<FAB> const*>& a_factory = {});
90
101 void define (const Vector<Geometry>& a_geom,
102 const Vector<BoxArray>& a_grids,
103 const Vector<DistributionMapping>& a_dmap,
104 const Vector<iMultiFab const*>& a_overset_mask,
105 const LPInfo& a_info = LPInfo(),
106 const Vector<FabFactory<FAB> const*>& a_factory = {});
107
121 void setShearViscosity (int amrlev, RT eta);
128 void setBulkViscosity (int amrlev, const Array<MF const*,AMREX_SPACEDIM>& kappa) {
129 setBulkViscosity<MF>(amrlev, kappa);
130 }
131
132 template <FabArrayType AMF>
133 requires (std::is_convertible_v<typename AMF::value_type, typename MF::value_type>)
134 void setBulkViscosity (int amrlev, const Array<AMF const*,AMREX_SPACEDIM>& kappa);
141 void setBulkViscosity (int amrlev, RT kappa);
142
143 [[nodiscard]] int getNComp () const final { return AMREX_SPACEDIM; }
144
145 [[nodiscard]] bool isCrossStencil () const final { return false; }
146 [[nodiscard]] bool isTensorOp () const final { return true; }
147
154 [[nodiscard]] bool needsUpdate () const final {
155 return (m_needs_update || MLABecLaplacianT<MF>::needsUpdate());
156 }
157
163 void update () final {
164 amrex::Abort("MLTensorOp: update TODO");
165 }
166
168 void prepareForSolve () final;
169 [[nodiscard]] bool supportsMixedPrecision () const override {
170 return typeid(*this) == typeid(MLTensorOpT<MF>);
171 }
172
173 [[nodiscard]] bool isSingular (int /*armlev*/) const final { return false; }
174 [[nodiscard]] bool isBottomSingular () const final { return false; }
175
187 void apply (int amrlev, int mglev, MF& out, MF& in, BCMode bc_mode,
188 StateMode s_mode, const MLMGBndryT<MF>* bndry=nullptr) const final;
189
198 void compFlux (int amrlev, const Array<MF*,AMREX_SPACEDIM>& fluxes,
199 MF& sol, Location loc) const override;
200
213 void compVelGrad (int amrlev, const Array<MF*,AMREX_SPACEDIM>& fluxes,
214 MF& sol, Location loc) const;
215
216 void setBCoeffs (int amrlev, const Array<MF const*,AMREX_SPACEDIM>& beta) = delete;
217
240 void setMappingFactors (int amrlev, const Array<MF const*,AMREX_SPACEDIM>& fac) {
241 setMappingFactors<MF>(amrlev, fac);
242 }
243
244 template <FabArrayType AMF>
245 requires (std::is_convertible_v<typename AMF::value_type, typename MF::value_type>)
247
249 [[nodiscard]] bool isMapped () const noexcept { return m_use_mapped; }
250
253 [[nodiscard]] bool hasMappingFactors (int amrlev) const noexcept {
254 return m_use_mapped && amrlev < static_cast<int>(m_mapfac.size())
255 && m_mapfac[amrlev][0].isDefined();
256 }
257
258protected:
259
260 bool m_has_kappa = false;
262
263 bool m_use_mapped = false;
264 Vector<Array<MF,AMREX_SPACEDIM> > m_mapfac; // per AMR level, MG level 0
265
266private:
267
268 bool m_needs_update = true;
269
270public: // for cuda
271
282 void applyBCTensor (int amrlev, int mglev, MF& vel,
283 BCMode bc_mode, StateMode s_mode, const MLMGBndryT<MF>* bndry
284 ) const;
285};
286
287template <typename MF>
288template <FabArrayType AMF>
289requires (std::is_convertible_v<typename AMF::value_type, typename MF::value_type>)
290void
292{
293 for (int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
294 m_kappa[amrlev][0][idim].LocalCopy(*kappa[idim], 0, 0, 1, IntVect(0));
295 }
296 m_has_kappa = true;
297 m_needs_update = true;
298 this->template spForward<MLTensorOpT>([&] (auto* sp) { sp->setBulkViscosity(amrlev, kappa); });
299}
300
301template <typename MF>
302template <FabArrayType AMF>
303requires (std::is_convertible_v<typename AMF::value_type, typename MF::value_type>)
304void
306{
307 if (m_mapfac.empty()) { m_mapfac.resize(this->NAMRLevels()); }
308 for (int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
309 AMREX_ALWAYS_ASSERT(fac[idim]->nComp() >= AMREX_SPACEDIM);
310 if (!m_mapfac[amrlev][idim].ok()) {
311 m_mapfac[amrlev][idim].define
312 (amrex::convert(this->m_grids[amrlev][0], IntVect::TheDimensionVector(idim)),
313 this->m_dmap[amrlev][0], AMREX_SPACEDIM, 0, MFInfo(), *this->m_factory[amrlev][0]);
314 }
315 m_mapfac[amrlev][idim].LocalCopy(*fac[idim], 0, 0, AMREX_SPACEDIM, IntVect(0));
316 }
317 m_use_mapped = true;
318 m_needs_update = true;
319 this->template spForward<MLTensorOpT>([&] (auto* sp) { sp->setMappingFactors(amrlev, fac); });
320}
321
322// Member functions are defined in the .cpp file. Only these instantiations exist.
323extern template class MLTensorOpT<MultiFab>;
324#ifdef AMREX_MLMG_HAS_FLOAT
325extern template class MLTensorOpT<fMultiFab>;
326#endif
327
330
331}
332
333#endif
Fixed-size array types for use on GPU and CPU.
#define AMREX_ALWAYS_ASSERT(EX)
Definition AMReX_BLassert.H:50
Abstract factory interface for creating, aliasing, and destroying FAB objects.
Definition AMReX_FabFactory.H:73
__host__ static __device__ constexpr IntVectND< dim > TheDimensionVector(int d) noexcept
Definition AMReX_IntVect.H:797
MLABecLaplacianT()=default
Construct an empty operator; call define() before solving.
bool needsUpdate() const override
True if coefficients need to be averaged down before the next apply().
Definition AMReX_MLABecLaplacian.H:170
Vector< Vector< std::unique_ptr< FabFactory< FAB > > > > m_factory
Definition AMReX_MLLinOp.H:1010
int NAMRLevels() const noexcept
Return the number of AMR levels.
Definition AMReX_MLLinOp.H:951
LinOpEnumType::StateMode StateMode
Definition AMReX_MLLinOp.H:173
Vector< Vector< BoxArray > > m_grids
Definition AMReX_MLLinOp.H:1008
Vector< Vector< DistributionMapping > > m_dmap
Definition AMReX_MLLinOp.H:1009
LinOpEnumType::Location Location
Definition AMReX_MLLinOp.H:174
LinOpEnumType::BCMode BCMode
Definition AMReX_MLLinOp.H:172
void spForward(F const &f)
Definition AMReX_MLLinOp.H:1185
Boundary helper for MLMG that manages coarse/fine and physical BC metadata.
Definition AMReX_MLMGBndry.H:20
Tensor solver with shear/bulk viscosity inputs for high-Reynolds flows.
Definition AMReX_MLTensorOp.H:39
typename MLLinOpT< MF >::Location Location
Definition AMReX_MLTensorOp.H:44
MLTensorOpT(const MLTensorOpT &)=delete
void setShearViscosity(int amrlev, RT eta)
Populate eta with a constant scalar.
Definition AMReX_MLTensorOp.cpp:122
bool m_use_mapped
Definition AMReX_MLTensorOp.H:263
void setBulkViscosity(int amrlev, const Array< MF const *, 3 > &kappa)
Provide bulk viscosity kappa as face-centered MultiFabs.
Definition AMReX_MLTensorOp.H:128
MLTensorOpT(const Vector< Geometry > &a_geom, const Vector< BoxArray > &a_grids, const Vector< DistributionMapping > &a_dmap, const Vector< iMultiFab const * > &a_overset_mask, const LPInfo &a_info=LPInfo(), const Vector< FabFactory< FAB > const * > &a_factory={})
Convenience constructor that includes overset-mask support (1 = unknown, 0 = known).
Definition AMReX_MLTensorOp.cpp:30
bool needsUpdate() const final
True if coefficients have changed since the last prepareForSolve().
Definition AMReX_MLTensorOp.H:154
void compVelGrad(int amrlev, const Array< MultiFab *, 3 > &fluxes, MultiFab &sol, Location loc) const
void setMappingFactors(int amrlev, const Array< MultiFab const *, 3 > &fac)
Definition AMReX_MLTensorOp.H:240
void define(const Vector< Geometry > &a_geom, const Vector< BoxArray > &a_grids, const Vector< DistributionMapping > &a_dmap, const Vector< iMultiFab const * > &a_overset_mask, const LPInfo &a_info=LPInfo(), const Vector< FabFactory< FAB > const * > &a_factory={})
Define the hierarchy with overset masks (1 = unknown, 0 = known).
Definition AMReX_MLTensorOp.cpp:78
typename MF::value_type RT
Definition AMReX_MLTensorOp.H:43
bool supportsMixedPrecision() const override
Definition AMReX_MLTensorOp.H:169
void apply(int amrlev, int mglev, MF &out, MF &in, BCMode bc_mode, StateMode s_mode, const MLMGBndryT< MF > *bndry=nullptr) const final
Apply the tensor operator on AMR level amrlev / MG level mglev.
Definition AMReX_MLTensorOp.cpp:227
bool isTensorOp() const final
Whether this operator is a tensor solve.
Definition AMReX_MLTensorOp.H:146
bool isSingular(int) const final
Query whether AMR level amrlev is singular (null space present).
Definition AMReX_MLTensorOp.H:173
void setBCoeffs(int amrlev, const Array< MultiFab const *, 3 > &beta)=delete
MLTensorOpT(const Vector< Geometry > &a_geom, const Vector< BoxArray > &a_grids, const Vector< DistributionMapping > &a_dmap, const LPInfo &a_info=LPInfo(), const Vector< FabFactory< FAB > const * > &a_factory={})
Convenience constructor without overset masks (for cell-only domains).
Definition AMReX_MLTensorOp.cpp:19
void setShearViscosity(int amrlev, const Array< MF const *, 3 > &eta)
Provide shear viscosity eta as face-centered MultiFabs.
Definition AMReX_MLTensorOp.cpp:115
bool m_has_kappa
Definition AMReX_MLTensorOp.H:260
typename MF::fab_type FAB
Definition AMReX_MLTensorOp.H:42
~MLTensorOpT() override=default
MLTensorOpT & operator=(const MLTensorOpT &)=delete
Vector< Array< MultiFab, 3 > > m_mapfac
Definition AMReX_MLTensorOp.H:264
bool isCrossStencil() const final
Whether the stencil is the cross shape.
Definition AMReX_MLTensorOp.H:145
void prepareForSolve() final
Assemble viscosity data/BC caches before solving.
Definition AMReX_MLTensorOp.cpp:144
MLTensorOpT(MLTensorOpT &&)=delete
MLTensorOpT()
Construct an empty tensor operator; call define() before solving.
Definition AMReX_MLTensorOp.cpp:13
typename MLLinOpT< MF >::StateMode StateMode
Definition AMReX_MLTensorOp.H:46
void compFlux(int amrlev, const Array< MultiFab *, 3 > &fluxes, MultiFab &sol, Location loc) const override
typename MLLinOpT< MF >::BCMode BCMode
Definition AMReX_MLTensorOp.H:45
void applyBCTensor(int amrlev, int mglev, MF &vel, BCMode bc_mode, StateMode s_mode, const MLMGBndryT< MF > *bndry) const
Apply tensor-specific boundary conditions on (amrlev,mglev).
Definition AMReX_MLTensorOp.cpp:367
Vector< Vector< Array< MultiFab, 3 > > > m_kappa
Definition AMReX_MLTensorOp.H:261
bool hasMappingFactors(int amrlev) const noexcept
Definition AMReX_MLTensorOp.H:253
int getNComp() const final
Return number of components.
Definition AMReX_MLTensorOp.H:143
void setBulkViscosity(int amrlev, RT kappa)
Populate kappa with a constant scalar.
Definition AMReX_MLTensorOp.cpp:130
void define(const Vector< Geometry > &a_geom, const Vector< BoxArray > &a_grids, const Vector< DistributionMapping > &a_dmap, const LPInfo &a_info=LPInfo(), const Vector< FabFactory< FAB > const * > &a_factory={})
Define the hierarchy for standard tensor solves.
Definition AMReX_MLTensorOp.cpp:43
bool isBottomSingular() const final
Convenience helper for the coarsest level singularity flag.
Definition AMReX_MLTensorOp.H:174
void update() final
Not implemented for tensor operators.
Definition AMReX_MLTensorOp.H:163
bool isMapped() const noexcept
True if setMappingFactors has been called for any AMR level.
Definition AMReX_MLTensorOp.H:249
This class is a thin wrapper around std::vector. Unlike vector, Vector::operator[] provides bound che...
Definition AMReX_Vector.H:29
__host__ __device__ BoxND< dim > convert(const BoxND< dim > &b, const IntVectND< dim > &typ) noexcept
Return a copy of b converted to the nodal flags typ.
Definition AMReX_Box.H:1632
std::array< T, N > Array
Definition AMReX_Array.H:31
MLTensorOpT< MultiFab > MLTensorOp
Definition AMReX_MLTensorOp.H:329
Definition AMReX_Amr.cpp:50
int nComp(FabArrayBase const &fa)
Convenience wrapper that forwards to fa.nComp().
Definition AMReX_FabArrayBase.cpp:3028
IntVectND< 3 > IntVect
IntVect is an alias for amrex::IntVectND instantiated with AMREX_SPACEDIM.
Definition AMReX_BaseFwd.H:38
void Abort(const std::string &msg)
Print a fatal-error message to stderr and abort execution.
Definition AMReX.cpp:239
Configuration knobs for multilevel linear operators (grid agglomeration, metrics, etc....
Definition AMReX_MLLinOp.H:54
FabArray memory allocation information.
Definition AMReX_FabArray.H:73