ScratchField.H

Go to the documentation of this file.

#ifndef SCRATCHFIELD_H
#define SCRATCHFIELD_H
 
#include <string>
#include <utility>
 
#include "amr-wind/core/FieldDescTypes.H"
#include "amr-wind/core/ViewField.H"
#include "AMReX_MultiFab.H"
#include "AMReX_Vector.H"
#include "AMReX_PhysBCFunct.H"
 
namespace amr_wind {
 
class FieldRepo;
 
class ScratchField
{
public:
    friend class FieldRepo;
 
    ScratchField(const ScratchField&) = delete;
    ScratchField& operator=(const ScratchField&) = delete;
 
    inline const std::string& name() const { return m_name; }
 
    inline int num_comp() const { return m_ncomp; }
 
    inline const amrex::IntVect& num_grow() const { return m_ngrow; }
 
    inline FieldLoc field_location() const { return m_floc; }
 
    amrex::MultiFab& operator()(int lev) { return m_data[lev]; }
    const amrex::MultiFab& operator()(int lev) const { return m_data[lev]; }
 
    amrex::Vector<amrex::MultiFab*> vec_ptrs() noexcept
    {
        return amrex::GetVecOfPtrs(m_data);
    }
 
    amrex::Vector<const amrex::MultiFab*> vec_const_ptrs() const noexcept
    {
        return amrex::GetVecOfConstPtrs(m_data);
    }
 
    const FieldRepo& repo() const { return m_repo; }
 
    ViewField<ScratchField> subview(const int scomp = 0, const int ncomp = 1)
    {
        return {*this, scomp, ncomp};
    }
 
    void fillpatch(const amrex::Real time) noexcept;
    void fillpatch(const amrex::Real time, const amrex::IntVect& ng) noexcept;
 
    void fillpatch(
        const int lev,
        const amrex::Real time,
        amrex::MultiFab& mfab,
        const amrex::IntVect& nghost) noexcept;
 
    void fillpatch(
        const int lev,
        const amrex::Real time,
        amrex::MultiFab& mfab,
        const amrex::IntVect& nghost,
        amrex::Vector<amrex::BCRec>& bcrec) noexcept;
 
protected:
    ScratchField(
        const FieldRepo& repo,
        std::string name,
        const int ncomp = 1,
        const int ngrow = 1,
        const FieldLoc floc = FieldLoc::CELL)
        : m_repo(repo)
        , m_name(std::move(name))
        , m_ncomp(ncomp)
        , m_ngrow(ngrow)
        , m_floc(floc)
    {}
 
    const FieldRepo& m_repo;
    std::string m_name;
    int m_ncomp;
    amrex::IntVect m_ngrow;
    FieldLoc m_floc;
 
    amrex::Vector<amrex::MultiFab> m_data;
};
 
} // namespace amr_wind
 
#endif /* SCRATCHFIELD_H */