WarpXUtil.H File Reference

#include <ablastr/fields/MultiFabRegister.H>
#include <AMReX_BoxArray.H>
#include <AMReX_DistributionMapping.H>
#include <AMReX_Extension.H>
#include <AMReX_GpuQualifiers.H>
#include <AMReX_LayoutData.H>
#include <AMReX_ParmParse.H>
#include <AMReX_Parser.H>
#include <AMReX_REAL.H>
#include <AMReX_Utility.H>
#include <AMReX_Vector.H>
#include <AMReX_BaseFwd.H>
#include <cstddef>
#include <cstdint>
#include <string>
#include <vector>

Go to the source code of this file.

Namespaces
namespace	WarpXUtilIO
namespace	WarpXUtilLoadBalance

Functions
void	ReadBoostedFrameParameters (amrex::Real &gamma_boost, amrex::Real &beta_boost, amrex::Vector< int > &boost_direction)
void	ReadMovingWindowParameters (int &do_moving_window, int &start_moving_window_step, int &end_moving_window_step, int &moving_window_dir, amrex::Real &moving_window_v)
void	ConvertLabParamsToBoost ()
void	CheckGriddingForRZSpectral ()
void	NullifyMFinstance (amrex::MultiFab *mf, int lev, amrex::Real zmin, amrex::Real zmax)
void	NullifyMF (ablastr::fields::MultiFabRegister &multifab_map, std::string const &mf_name, int lev, amrex::Real zmin, amrex::Real zmax)
void	NullifyMF (ablastr::fields::MultiFabRegister &multifab_map, std::string const &mf_name, ablastr::fields::Direction dir, int lev, amrex::Real zmin, amrex::Real zmax)
bool	WarpXUtilIO::WriteBinaryDataOnFile (const std::string &filename, const amrex::Vector< char > &data)
bool	WarpXUtilLoadBalance::doCosts (const amrex::LayoutData< amrex::Real > *cost, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm)
	We only want to update the cost data if the grids we are working on are the main grids, i.e. not the PML grids. This function returns whether this is the case or not.

Function Documentation

CheckGriddingForRZSpectral()

void CheckGriddingForRZSpectral

(

)

Check the warpx.dims matches the binary name & set up RZ gridding

Ensures that the blocks are setup correctly for the RZ spectral solver When using the RZ spectral solver, the Hankel transform cannot be divided among multiple blocks. Each block must extend over the entire radial extent. The grid can be divided up along z, but the number of blocks must be >= the number of processors.

ConvertLabParamsToBoost()

void ConvertLabParamsToBoost

(

)

NullifyMF() [1/2]

void NullifyMF	(	ablastr::fields::MultiFabRegister &	multifab_map,
		std::string const &	mf_name,
		ablastr::fields::Direction	dir,
		int	lev,
		amrex::Real	zmin,
		amrex::Real	zmax )

Function that sets the value of MultiFab MF to zero.

Parameters

[in]	multifab_map	Multifab registry
[in]	mf_name	Name of Multifab to modify
[in]	dir	Direction, for Multifabs that are components of vectors
[in]	lev	The mesh refinement level
[in]	zmin	The minimum z of the range to be nullified
[in]	zmax	The maximum z of the range to be nullified

NullifyMF() [2/2]

void NullifyMF	(	ablastr::fields::MultiFabRegister &	multifab_map,
		std::string const &	mf_name,
		int	lev,
		amrex::Real	zmin,
		amrex::Real	zmax )

Function that sets the value of MultiFab MF to zero.

Parameters

[in]	multifab_map	Multifab registry
[in]	mf_name	Name of Multifab to modify
[in]	lev	The mesh refinement level
[in]	zmin	The minimum z of the range to be nullified
[in]	zmax	The maximum z of the range to be nullified

NullifyMFinstance()

void NullifyMFinstance	(	amrex::MultiFab *	mf,
		int	lev,
		amrex::Real	zmin,
		amrex::Real	zmax )

Function that sets the value of MultiFab MF to zero.

Parameters

[in]	mf	Pointer to the MultiFab
[in]	lev	The mesh refinement level
[in]	zmin	The minimum z of the range to be nullified
[in]	zmax	The maximum z of the range to be nullified

ReadBoostedFrameParameters()

void ReadBoostedFrameParameters	(	amrex::Real &	gamma_boost,
		amrex::Real &	beta_boost,
		amrex::Vector< int > &	boost_direction )

ReadMovingWindowParameters()

void ReadMovingWindowParameters	(	int &	do_moving_window,
		int &	start_moving_window_step,
		int &	end_moving_window_step,
		int &	moving_window_dir,
		amrex::Real &	moving_window_v )