VelocityProperties.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_VELOCITY_PROPERTIES_H_
#define WARPX_VELOCITY_PROPERTIES_H_
 
#include <AMReX_ParmParse.H>
#include <AMReX_Parser.H>
#include <AMReX_REAL.H>
 
/* Type of velocity initialization. Used by VelocityProperties and GetVelocity. */
enum VelocityInitType {VelConstantValue, VelParserFunction};

struct VelocityProperties
{
    VelocityProperties (const amrex::ParmParse& pp, std::string const& source_name);
 
    /* Type of velocity initialization */
    VelocityInitType m_type;
 
    /* Velocity direction */
    int m_dir; // Index x=0, y=1, z=2
    int m_sign_dir; // Sign of the velocity direction positive=1, negative=-1
 
    /* Constant velocity value, if m_type == VelConstantValue */
    amrex::Real m_velocity{0};
    /* Storage of the parser function, if m_type == VelParserFunction */
    std::unique_ptr<amrex::Parser> m_ptr_velocity_parser;
};
 
#endif //WARPX_VELOCITY_PROPERTIES_H_