GetVelocity.H

Go to the documentation of this file.

/* Copyright 2021 Hannah Klion
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */
 
#ifndef WARPX_GET_VELOCITY_H_
#define WARPX_GET_VELOCITY_H_
 
#include "VelocityProperties.H"

struct GetVelocity
{
    /* Type of velocity initialization */
    VelocityInitType m_type;
 
    /* Velocity direction */
    int m_dir; 
    int m_sign_dir; 

    amrex::Real m_velocity{0};
    amrex::ParserExecutor<3> m_velocity_parser;

    explicit GetVelocity (VelocityProperties const& vel) noexcept;

    AMREX_GPU_HOST_DEVICE
    amrex::Real operator() (amrex::Real const x, amrex::Real const y, amrex::Real const z) const noexcept
    {
        switch (m_type)
        {
            case (VelConstantValue):
            {
                return m_sign_dir * m_velocity;
            }
            case (VelParserFunction):
            {
                return m_sign_dir * m_velocity_parser(x,y,z);
            }
            default:
            {
                amrex::Abort("Get initial velocity: unknown type");
                return 0.0;
            }
        }
    }

    [[nodiscard]]
    AMREX_GPU_HOST_DEVICE
    int direction () const noexcept
    {
        return m_dir;
    }
};
 
struct GetVelocityVector
{
    /* Type of velocity initialization */
    VelocityInitType m_type;

    amrex::Real m_ux_mean{0}, m_uy_mean{0}, m_uz_mean{0};
    amrex::ParserExecutor<3> m_ux_mean_parser, m_uy_mean_parser, m_uz_mean_parser;
    explicit GetVelocityVector (VelocityProperties const& vel) noexcept;

    AMREX_GPU_HOST_DEVICE
    amrex::XDim3 operator() (amrex::Real const x, amrex::Real const y, amrex::Real const z) const noexcept
    {
        switch (m_type)
        {
            case (VelConstantVector):
            {
                return amrex::XDim3{ m_ux_mean, m_uy_mean, m_uz_mean };
            }
            case (VelParserFunctionVector):
            {
                return amrex::XDim3{ m_ux_mean_parser(x,y,z), m_uy_mean_parser(x,y,z), m_uz_mean_parser(x,y,z) };
            }
            default:
            {
                amrex::Abort("Get initial velocity: unknown type");
                return amrex::XDim3{0.0, 0.0, 0.0};
            }
        }
    }
};
 
#endif //WARPX_GET_VELOCITY_H_