Hipace
Public Member Functions | Public Attributes | List of all members
GetInitialDensity Struct Reference

Functor gets the initial density for beam particles for a given position. More...

#include <GetInitialDensity.H>

Public Member Functions

 GetInitialDensity ()=default
 
 GetInitialDensity (const std::string &name, amrex::Parser &parser)
 
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real operator() (const amrex::Real x, const amrex::Real y, const amrex::Real z) const
 returns the density for a beam particle at a given position More...
 

Public Attributes

amrex::RealVect m_position_mean {0.,0.,0.}
 
amrex::RealVect m_position_std {0.,0.,0.}
 
BeamProfileType m_profile
 
amrex::Real m_density
 
amrex::ParserExecutor< 3 > m_density_func
 

Detailed Description

Functor gets the initial density for beam particles for a given position.

Constructor & Destructor Documentation

◆ GetInitialDensity() [1/2]

GetInitialDensity::GetInitialDensity ( )
default

Constructor.

◆ GetInitialDensity() [2/2]

GetInitialDensity::GetInitialDensity ( const std::string &  name,
amrex::Parser parser 
)

Member Function Documentation

◆ operator()()

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real GetInitialDensity::operator() ( const amrex::Real  x,
const amrex::Real  y,
const amrex::Real  z 
) const
inline

returns the density for a beam particle at a given position

Parameters
[in]xposition in x
[in]yposition in y
[in]zposition in z

Member Data Documentation

◆ m_density

amrex::Real GetInitialDensity::m_density

Peak density of the beam

◆ m_density_func

amrex::ParserExecutor<3> GetInitialDensity::m_density_func

Density function for the plasma

◆ m_position_mean

amrex::RealVect GetInitialDensity::m_position_mean {0.,0.,0.}

◆ m_position_std

amrex::RealVect GetInitialDensity::m_position_std {0.,0.,0.}

◆ m_profile

BeamProfileType GetInitialDensity::m_profile

The documentation for this struct was generated from the following files: