impactx::initialization Namespace Reference
Namespaces | |
| namespace | details |
Classes | |
| class | AmrCoreData |
| struct | InitSingleParticleData |
| struct | InitSingleParticleSpin |
Function Documentation
◆ amrex_amrcore_gridding()
| AmrCoreData impactx::initialization::amrex_amrcore_gridding | ( | ) |
This lets AMReX AmrCore/AmrMesh build the boxes for each MPI-rank
This uses the regular logic in AmrCore/AmrMesh to grid boxes and refinement levels.
- Returns
- simulation_geometry the geometry (topology) of the simulation; amr_info contains information on mesh-refinement and box/grid blocks
◆ create_envelope()
| Envelope impactx::initialization::create_envelope | ( | distribution::KnownDistributions const & | distr, |
| std::optional< amrex::ParticleReal > | intensity = std::nullopt ) |
Ignore the shape of a distribution and use the 2nd moments to create a covariance matrix
- Parameters
-
distr the distribution to draw from intensity the beam charge (in C, 3D space charge) or current (in A, 2D space charge)
◆ default_init_AMReX() [1/2]
| void impactx::initialization::default_init_AMReX | ( | ) |
Initialize AMReX
Initializes AMReX if not already done.
◆ default_init_AMReX() [2/2]
| void impactx::initialization::default_init_AMReX | ( | int | argc, |
| char * | argv[] ) |
Initialize AMReX
Initializes AMReX if not already done.
◆ init_amr_core()
| AmrCoreData impactx::initialization::init_amr_core | ( | ) |
This creates AMReX boxes for each MPI-rank
- Returns
- simulation_geometry the geometry (topology) of the simulation; amr_info contains information on mesh-refinement and box/grid blocks
◆ one_box_per_rank()
| AmrCoreData impactx::initialization::one_box_per_rank | ( | ) |
This builds one AMReX box per MPI-rank
This is a simple decomposition for particles that we default to if we do not need space charge or load balancing.
- Returns
- simulation_geometry the geometry (topology) of the simulation; amr_info contains information on mesh-refinement and box/grid blocks
◆ overwrite_amrex_parser_defaults()
| void impactx::initialization::overwrite_amrex_parser_defaults | ( | ) |
Overwrite defaults in AMReX Inputs
This overwrites defaults in amrex::ParamParse for inputs.
◆ read_distribution()
| distribution::KnownDistributions impactx::initialization::read_distribution | ( | amrex::ParmParse const & | pp_dist | ) |
Read a distribution configuration from inputs
- Parameters
-
pp_dist the distribution group in the ParmParser
- Returns
- a configured distribution
◆ read_mr_prob_relative()
| amrex::Vector< amrex::Real > impactx::initialization::read_mr_prob_relative | ( | ) |
◆ read_reference_particle()
| RefPart impactx::initialization::read_reference_particle | ( | amrex::ParmParse const & | pp_dist | ) |
Read the reference particle configuration from inputs
- Parameters
-
pp_dist the distribution group in the ParmParser
- Returns
- a configured reference particle
◆ set_distribution_parameters_from_phase_space_inputs()
| void impactx::initialization::set_distribution_parameters_from_phase_space_inputs | ( | amrex::ParmParse const & | pp_dist, |
| amrex::ParticleReal & | lambdax, | ||
| amrex::ParticleReal & | lambday, | ||
| amrex::ParticleReal & | lambdat, | ||
| amrex::ParticleReal & | lambdapx, | ||
| amrex::ParticleReal & | lambdapy, | ||
| amrex::ParticleReal & | lambdapt, | ||
| amrex::ParticleReal & | muxpx, | ||
| amrex::ParticleReal & | muypy, | ||
| amrex::ParticleReal & | mutpt, | ||
| amrex::ParticleReal & | meanx, | ||
| amrex::ParticleReal & | meany, | ||
| amrex::ParticleReal & | meant, | ||
| amrex::ParticleReal & | meanpx, | ||
| amrex::ParticleReal & | meanpy, | ||
| amrex::ParticleReal & | meanpt, | ||
| amrex::ParticleReal & | dispx, | ||
| amrex::ParticleReal & | disppx, | ||
| amrex::ParticleReal & | dispy, | ||
| amrex::ParticleReal & | disppy ) |
Initialize the input parameters for all distributions that read phase space ellipse parameters from the input
This function sets the distribution parameters based on the provided phase space inputs. The parameters include the phase space ellipse intersections for position (lambdaX, lambdaY), time (lambdaT), momentum (lambdaPx, lambdaPy) and energy (lambdaPt), as well as the correlation terms (muxpx, muypy, mutpt).
- Parameters
-
pp_dist The parameter parser object. lambdax Reference to the variable storing the axis intersection of the phase space ellipse for x position. lambday Reference to the variable storing the axis intersection of the phase space ellipse for y position. lambdat Reference to the variable storing the axis intersection of the phase space ellipse for time. lambdapx Reference to the variable storing the axis intersection of the phase space ellipse for momentum in x direction. lambdapy Reference to the variable storing the axis intersection of the phase space ellipse for momentum in y direction. lambdapt Reference to the variable storing the axis intersection of the phase space ellipse for energy. muxpx Reference to the variable storing the correlation coefficient between the x position and the x momentum. muypy Reference to the variable storing the correlation coefficient between the y position and the y momentum. mutpt Reference to the variable storing the correlation coefficient between the t position and the t momentum. meanx Reference to the variable storing the mean for position in the x direction. meany Reference to the variable storing the mean for position in the y direction. meant Reference to the variable storing the mean for position in the t direction. meanpx Reference to the variable storing the mean for momentum in the x direction. meanpy Reference to the variable storing the mean for momentum in the y direction. meanpt Reference to the variable storing the mean for momentum in the t direction. dispx Reference to the variable storing the beam-based dispersion in the x direction. disppx Reference to the variable storing the derivative of the beam-based dispersion in the x direction. dispy Reference to the variable storing the beam-based dispersion in the y direction. disppy Reference to the variable storing the derivative of the beam-based dispersion in the y direction.
◆ set_distribution_parameters_from_twiss_inputs()
| void impactx::initialization::set_distribution_parameters_from_twiss_inputs | ( | amrex::ParmParse const & | pp_dist, |
| amrex::ParticleReal & | lambdax, | ||
| amrex::ParticleReal & | lambday, | ||
| amrex::ParticleReal & | lambdat, | ||
| amrex::ParticleReal & | lambdapx, | ||
| amrex::ParticleReal & | lambdapy, | ||
| amrex::ParticleReal & | lambdapt, | ||
| amrex::ParticleReal & | muxpx, | ||
| amrex::ParticleReal & | muypy, | ||
| amrex::ParticleReal & | mutpt, | ||
| amrex::ParticleReal & | meanx, | ||
| amrex::ParticleReal & | meany, | ||
| amrex::ParticleReal & | meant, | ||
| amrex::ParticleReal & | meanpx, | ||
| amrex::ParticleReal & | meanpy, | ||
| amrex::ParticleReal & | meanpt, | ||
| amrex::ParticleReal & | dispx, | ||
| amrex::ParticleReal & | disppx, | ||
| amrex::ParticleReal & | dispy, | ||
| amrex::ParticleReal & | disppy ) |
Set the distribution parameters from Twiss inputs
This function reads Courant-Snyder / Twiss parameters from the provided ParmParse object and calculates the distribution parameters for a particle beam. It sets the values for the axis intercepts of the phase space ellipse (lambdaX, lambdaY, lambdaT, and lambdaPx, lambdaPy, lambdaPt) and correlation terms (muxpx, muypy, mutpt) normally accepted as input.
- Parameters
-
pp_dist The parameter parser object. lambdax Reference to the variable storing the axis intersection of the phase space ellipse for x position. lambday Reference to the variable storing the axis intersection of the phase space ellipse for y position. lambdat Reference to the variable storing the axis intersection of the phase space ellipse for time. lambdapx Reference to the variable storing the axis intersection of the phase space ellipse for momentum in x direction. lambdapy Reference to the variable storing the axis intersection of the phase space ellipse for momentum in y direction. lambdapt Reference to the variable storing the axis intersection of the phase space ellipse for energy. muxpx Reference to the variable storing the correlation coefficient between the x position and the x momentum. muypy Reference to the variable storing the correlation coefficient between the y position and the y momentum. mutpt Reference to the variable storing the correlation coefficient between the t position and the t momentum. meanx Reference to the variable storing the mean for position in the x direction. meany Reference to the variable storing the mean for position in the y direction. meant Reference to the variable storing the mean for position in the t direction. meanpx Reference to the variable storing the mean for momentum in the x direction. meanpy Reference to the variable storing the mean for momentum in the y direction. meanpt Reference to the variable storing the mean for momentum in the t direction. dispx Reference to the variable storing the beam-based dispersion in the x direction. disppx Reference to the variable storing the derivative of the beam-based dispersion in the x direction. dispy Reference to the variable storing the beam-based dispersion in the y direction. disppy Reference to the variable storing the derivative of the beam-based dispersion in the y direction.
◆ undefined_geometry_prob_hi()
|
constexpr |
the fake domain size (higher end), used to indicate that the user made no choice for it
◆ undefined_geometry_prob_lo()
|
constexpr |
the fake domain size (lower end), used to indicate that the user made no choice for it
Generated by
1.13.2