Hipace
Public Member Functions | Private Attributes | List of all members
GridCurrent Class Reference

class handling a current directly written to the grid More...

#include <GridCurrent.H>

Public Member Functions

 GridCurrent ()
 
void DepositCurrentSlice (Fields &fields, const amrex::Geometry &geom, int const lev, const int islice)
 

Private Attributes

bool m_use_grid_current = false
 
amrex::RealVect m_position_mean {0., 0., 0.}
 
amrex::RealVect m_position_std {0., 0., 0.}
 
amrex::Real m_peak_current_density {0.}
 

Detailed Description

class handling a current directly written to the grid

Constructor & Destructor Documentation

◆ GridCurrent()

GridCurrent::GridCurrent ( )
explicit

Constructor

Member Function Documentation

◆ DepositCurrentSlice()

void GridCurrent::DepositCurrentSlice ( Fields fields,
const amrex::Geometry geom,
int const  lev,
const int  islice 
)

calculate the adaptive time step based on the beam energy

Parameters
[in,out]fieldsthe general field class, modified by this function
[in]geomGeometry of the simulation, to get the cell size etc.
[in]levMR level
[in]isliceindex of the slice on which the beam particles are pushed

Member Data Documentation

◆ m_peak_current_density

amrex::Real GridCurrent::m_peak_current_density {0.}
private

peak density for the grid current

◆ m_position_mean

amrex::RealVect GridCurrent::m_position_mean {0., 0., 0.}
private

Average position of the Gaussian grid current.

◆ m_position_std

amrex::RealVect GridCurrent::m_position_std {0., 0., 0.}
private

Width of the Gaussian grid current.

◆ m_use_grid_current

bool GridCurrent::m_use_grid_current = false
private

Whether to use a grid current


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