AMReX_TagBox.H

Go to the documentation of this file.

 
#ifndef AMREX_TagBox_H_
#define AMREX_TagBox_H_
#include <AMReX_Config.H>
 
#include <AMReX_IntVect.H>
#include <AMReX_Box.H>
#include <AMReX_Array.H>
#include <AMReX_Vector.H>
#include <AMReX_BaseFab.H>
#include <AMReX_FabArray.H>
#include <AMReX_BoxArray.H>
#include <AMReX_Geometry.H>

 
namespace amrex {
 

class TagBox final
    :
    public BaseFab<char>
{
public:

    using TagType = char;

    enum TagVal { CLEAR=0, BUF, SET };
 
    TagBox () noexcept = default;
 
    explicit TagBox (Arena* ar) noexcept;
 
    TagBox (const Box& bx, int n, Arena* ar);
 
    explicit TagBox (const Box& bx, int n = 1, bool alloc = true,
                     bool shared = false, Arena* ar = nullptr);
 
    TagBox (const TagBox& rhs, MakeType make_type, int scomp, int ncomp);
 
    ~TagBox () noexcept override = default;
 
    TagBox (TagBox&& rhs) noexcept = default;
 
    TagBox (const TagBox& rhs) = delete;
    TagBox& operator= (const TagBox& rhs) = delete;
    TagBox& operator= (TagBox&& rhs) = delete;
 

    void coarsen (const IntVect& ratio, const Box& cbox) noexcept;

    void buffer (const IntVect& a_nbuff, const IntVect& nwid) noexcept;

//#if (__cplusplus >= 201402L)
//    [[deprecated("No need to use this unless calling Fortran < 2003")]]
//#endif
    [[nodiscard]] Vector<int> tags () const noexcept;

//#if (__cplusplus >= 201402L)
//    [[deprecated("No need to use this unless calling Fortran < 2003")]]
//#endif
    void get_itags(Vector<int>& ar, const Box& tilebx) const noexcept;

//#if (__cplusplus >= 201402L)
//    [[deprecated("No need to use this unless calling Fortran < 2003")]]
//#endif
    void tags (const Vector<int>& ar) noexcept;

//#if (__cplusplus >= 201402L)
//    [[deprecated("No need to use this unless calling Fortran < 2003")]]
//#endif
    void tags_and_untags (const Vector<int>& ar) noexcept;

//#if (__cplusplus >= 201402L)
//    [[deprecated("No need to use this unless calling Fortran < 2003")]]
//#endif
    void tags (const Vector<int>& ar, const Box& tilebx) noexcept;

//#if (__cplusplus >= 201402L)
//    [[deprecated("No need to use this unless calling Fortran < 2003")]]
//#endif
    void tags_and_untags (const Vector<int>& ar, const Box& tilebx) noexcept;
};
 

class TagBoxArray
    :
    public FabArray<TagBox>
{
public:

    using TagType = TagBox::TagType;

    TagBoxArray (const BoxArray& ba, const DistributionMapping& dm, int _ngrow=0);
    TagBoxArray (const BoxArray& ba, const DistributionMapping& dm, const IntVect& _ngrow);
 
    ~TagBoxArray () = default;
 
    TagBoxArray (TagBoxArray&& rhs) noexcept = default;
    TagBoxArray& operator= (TagBoxArray&& rhs) noexcept = default;
 
    TagBoxArray (const TagBoxArray& rhs) = delete;
    TagBoxArray& operator= (const TagBoxArray& rhs) = delete;

    void buffer (const IntVect& nbuf);

    void mapPeriodicRemoveDuplicates (const Geometry& geom);

    void setVal (const BoxArray& ba, TagBox::TagVal val);
    using FabArray<TagBox>::setVal;

    void coarsen (const IntVect& ratio);

    void coarsenMayOverlap (const IntVect& ratio, bool may_overlap);

    void collate (Gpu::PinnedVector<IntVect>& TheGlobalCollateSpace) const;

    bool hasTags (Box const& bx) const;
 
    void local_collate_cpu (Gpu::PinnedVector<IntVect>& v) const;
#ifdef AMREX_USE_GPU
    void local_collate_gpu (Gpu::PinnedVector<IntVect>& v) const;
#endif
 
private:
    bool m_may_overlap = false;
};
 
}
 
#endif /*_TagBox_H_*/