1#ifndef AMREX_ML_TENSOR_OP_H_
2#define AMREX_ML_TENSOR_OP_H_
3#include <AMReX_Config.H>
10#define AMREX_MLTENSOROP_HAS_MAPPING_FACTORS 1
42 using FAB =
typename MF::fab_type;
43 using RT =
typename MF::value_type;
132 template <FabArrayType AMF>
133 requires (std::is_convertible_v<typename AMF::value_type, typename MF::value_type>)
143 [[nodiscard]]
int getNComp () const final {
return AMREX_SPACEDIM; }
146 [[nodiscard]]
bool isTensorOp () const final {
return true; }
173 [[nodiscard]]
bool isSingular (
int )
const final {
return false; }
187 void apply (
int amrlev,
int mglev, MF& out, MF& in,
BCMode bc_mode,
199 MF& sol,
Location loc) const override;
244 template <FabArrayType AMF>
245 requires (std::is_convertible_v<typename AMF::value_type, typename MF::value_type>)
268 bool m_needs_update =
true;
287template <
typename MF>
288template <FabArrayType AMF>
289requires (std::is_convertible_v<typename AMF::value_type, typename MF::value_type>)
293 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
294 m_kappa[amrlev][0][idim].LocalCopy(*kappa[idim], 0, 0, 1,
IntVect(0));
297 m_needs_update =
true;
301template <
typename MF>
302template <FabArrayType AMF>
303requires (std::is_convertible_v<typename AMF::value_type, typename MF::value_type>)
308 for (
int idim = 0; idim < AMREX_SPACEDIM; ++idim) {
315 m_mapfac[amrlev][idim].LocalCopy(*fac[idim], 0, 0, AMREX_SPACEDIM,
IntVect(0));
318 m_needs_update =
true;
324#ifdef AMREX_MLMG_HAS_FLOAT
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