BcTypes.h

//   This file contains the abstract base class for
//   field boundary conditions and other child classes
//   which represent specific BCs. At the moment the
//   following field BCs are supported
//
//   1. Periodic BC
//   2. Zero BC
//   3. Specifying a constant BC
//   4. No BC (default option)
//   5. Constant extrapolation BC
//   Only cell-centered field BCs are implemented
//   at the moment.
//
#ifndef IPPL_FIELD_BC_TYPES_H
#define IPPL_FIELD_BC_TYPES_H
 
#include "Types/IpplTypes.h"
#include "Types/ViewTypes.h"
 
#include "Communicate/Archive.h"
#include "FieldLayout/FieldLayout.h"
#include "Index/NDIndex.h"
#include "Meshes/UniformCartesian.h"
 
namespace ippl {
    /*
     * Enum type to identify different kinds of
     * field boundary conditions. Since ZeroFace is
     * a special case of ConstantFace, both will match
     * a bitwise AND with CONSTANT_FACE
     * (to avoid conflict with particle BC enum, add _FACE)
     */
    enum FieldBC {
        PERIODIC_FACE    = 0b0000,
        CONSTANT_FACE    = 0b0001,
        ZERO_FACE        = 0b0011,
        EXTRAPOLATE_FACE = 0b0100,
        NO_FACE          = 0b1000,
    };
 
    namespace detail {
        template <typename Field>
        class BCondBase {
            constexpr static unsigned Dim = Field::dim;
 
        public:
            using Layout_t = FieldLayout<Dim>;
 
            // Constructor takes:
            // face: the face to apply the boundary condition on.
            // i : what component of T to apply the boundary condition to.
            // The components default to setting all components.
            BCondBase(unsigned int face);
 
            KOKKOS_FUNCTION
            virtual ~BCondBase() {}
 
            virtual FieldBC getBCType() const { return NO_FACE; }
 
            virtual void findBCNeighbors(Field& field)          = 0;
            virtual void apply(Field& field)                    = 0;
            virtual void assignGhostToPhysical(Field& field) = 0;
            virtual void write(std::ostream&) const             = 0;
 
            // Return face on which BC applies
            unsigned int getFace() const { return face_m; }
 
            // Returns whether or not this BC changes physical cells.
            bool changesPhysicalCells() const { return changePhysical_m; }
 
        protected:
            // What face to apply the boundary condition to.
            unsigned int face_m;
 
            // True if this boundary condition changes physical cells.
            bool changePhysical_m;
        };
 
        template <typename Field>
        std::ostream& operator<<(std::ostream&, const BCondBase<Field>&);
 
    }  // namespace detail
 
    template <typename Field>
    class ExtrapolateFace : public detail::BCondBase<Field> {
        constexpr static unsigned Dim = Field::dim;
        using T                       = typename Field::value_type;
 
    public:
        // Constructor takes zero, one, or two int's specifying components of
        // multicomponent types like Vector this BC applies to.
        // Zero int's specified means apply to all components; one means apply to
        // component (i), and two means apply to component (i,j),
        using base_type = detail::BCondBase<Field>;
        using Layout_t  = typename detail::BCondBase<Field>::Layout_t;
 
        ExtrapolateFace(unsigned face, T offset, T slope)
            : base_type(face)
            , offset_m(offset)
            , slope_m(slope) {}
 
        KOKKOS_FUNCTION
        virtual ~ExtrapolateFace() {}
 
        virtual FieldBC getBCType() const { return EXTRAPOLATE_FACE; }
 
        virtual void findBCNeighbors(Field& /*field*/) {}
        virtual void apply(Field& field);
        virtual void assignGhostToPhysical(Field& field);
 
        virtual void write(std::ostream& out) const;
 
        const T& getOffset() const { return offset_m; }
        const T& getSlope() const { return slope_m; }
 
    protected:
        T offset_m;
        T slope_m;
    };
 
    template <typename Field>
    class NoBcFace : public detail::BCondBase<Field> {
    public:
        NoBcFace(int face)
            : detail::BCondBase<Field>(face) {}
 
        virtual void findBCNeighbors(Field& /*field*/) {}
        virtual void apply(Field& /*field*/) {}
        virtual void assignGhostToPhysical(Field& /*field*/) {}
 
        virtual void write(std::ostream& out) const;
    };
 
    template <typename Field>
    class ConstantFace : public ExtrapolateFace<Field> {
        using T = typename Field::value_type;
 
    public:
        ConstantFace(unsigned int face, T constant)
            : ExtrapolateFace<Field>(face, constant, 0) {}
 
        virtual FieldBC getBCType() const { return CONSTANT_FACE; }
 
        virtual void write(std::ostream& out) const;
    };
 
    template <typename Field>
    class ZeroFace : public ConstantFace<Field> {
    public:
        ZeroFace(unsigned face)
            : ConstantFace<Field>(face, 0.0) {}
 
        virtual FieldBC getBCType() const { return ZERO_FACE; }
 
        virtual void write(std::ostream& out) const;
    };
 
    template <typename Field>
    class PeriodicFace : public detail::BCondBase<Field> {
        constexpr static unsigned Dim = Field::dim;
        using T                       = typename Field::value_type;
 
    public:
        using face_neighbor_type = std::array<std::vector<int>, 2 * Dim>;
        using Layout_t           = typename detail::BCondBase<Field>::Layout_t;
 
        PeriodicFace(unsigned face)
            : detail::BCondBase<Field>(face) {}
 
        virtual FieldBC getBCType() const { return PERIODIC_FACE; }
 
        virtual void findBCNeighbors(Field& field);
        virtual void apply(Field& field);
        virtual void assignGhostToPhysical(Field& field);
 
        virtual void write(std::ostream& out) const;
 
    private:
        face_neighbor_type faceNeighbors_m;
        typename Field::halo_type::databuffer_type haloData_m;
    };
}  // namespace ippl
 
#include "Field/BcTypes.hpp"
 
#endif