#include <WarpXFluidContainer.H>

Public Member Functions
	WarpXFluidContainer (int ispecies, const std::string &name)

	~WarpXFluidContainer ()=default

	WarpXFluidContainer (WarpXFluidContainer const &)=delete

WarpXFluidContainer &	operator= (WarpXFluidContainer const &)=delete

	WarpXFluidContainer (WarpXFluidContainer &&)=default

WarpXFluidContainer &	operator= (WarpXFluidContainer &&)=default

void	AllocateLevelMFs (ablastr::fields::MultiFabRegister &m_fields, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm, int lev) const

void	InitData (ablastr::fields::MultiFabRegister &m_fields, amrex::Box init_box, amrex::Real cur_time, int lev, const amrex::Geometry &geom_lev, amrex::Real gamma_boost, amrex::Real beta_boost)

void	ReadParameters ()

void	Evolve (ablastr::fields::MultiFabRegister &fields, int lev, const std::string &current_fp_string, amrex::Real cur_time, bool skip_deposition=false)

void	AdvectivePush_Muscl (ablastr::fields::MultiFabRegister &m_fields, int lev)
	Advective term, cold-rel. fluids.

void	ApplyBcFluidsAndComms (ablastr::fields::MultiFabRegister &m_fields, int lev)
	Apply non-periodic BC to fluids and communicate boundaries.

void	centrifugal_source_rz (ablastr::fields::MultiFabRegister &m_fields, int lev)
	Centrifugal source term.

void	GatherAndPush (ablastr::fields::MultiFabRegister &m_fields, const amrex::MultiFab &Ex, const amrex::MultiFab &Ey, const amrex::MultiFab &Ez, const amrex::MultiFab &Bx, const amrex::MultiFab &By, const amrex::MultiFab &Bz, amrex::Real t, int lev)
	Lorentz Momentum Source.

void	DepositCurrent (ablastr::fields::MultiFabRegister &m_fields, amrex::MultiFab &jx, amrex::MultiFab &jy, amrex::MultiFab &jz, int lev)
	Deposit fluid current density.

void	DepositCharge (ablastr::fields::MultiFabRegister &m_fields, amrex::MultiFab &rho, int lev, int icomp=0)
	Deposit fluid charge density.

amrex::Real	getCharge () const

amrex::Real	getMass () const

Public Attributes
friend	MultiFluidContainer

std::string	name_mf_N = "fluid_density_"+species_name

std::string	name_mf_NU = "fluid_momentum_density_"+species_name

Protected Attributes
int	species_id

std::string	species_name

amrex::Real	charge

amrex::Real	mass

int	do_not_push = 0

int	do_not_gather = 0

int	do_not_deposit = 0

PhysicalSpecies	physical_species

std::string	m_B_ext_s = "none"

std::string	m_E_ext_s = "none"

std::unique_ptr< amrex::Parser >	m_Bx_parser

std::unique_ptr< amrex::Parser >	m_By_parser

std::unique_ptr< amrex::Parser >	m_Bz_parser

amrex::ParserExecutor< 4 >	m_Bxfield_parser

amrex::ParserExecutor< 4 >	m_Byfield_parser

amrex::ParserExecutor< 4 >	m_Bzfield_parser

std::unique_ptr< amrex::Parser >	m_Ex_parser

std::unique_ptr< amrex::Parser >	m_Ey_parser

std::unique_ptr< amrex::Parser >	m_Ez_parser

amrex::ParserExecutor< 4 >	m_Exfield_parser

amrex::ParserExecutor< 4 >	m_Eyfield_parser

amrex::ParserExecutor< 4 >	m_Ezfield_parser

std::unique_ptr< InjectorDensity, InjectorDensityDeleter >	h_inj_rho

InjectorDensity *	d_inj_rho = nullptr

std::unique_ptr< amrex::Parser >	density_parser

std::unique_ptr< InjectorMomentum, InjectorMomentumDeleter >	h_inj_mom

InjectorMomentum *	d_inj_mom = nullptr

std::unique_ptr< amrex::Parser >	ux_parser

std::unique_ptr< amrex::Parser >	uy_parser

std::unique_ptr< amrex::Parser >	uz_parser

std::unique_ptr< amrex::Parser >	ux_th_parser

std::unique_ptr< amrex::Parser >	uy_th_parser

std::unique_ptr< amrex::Parser >	uz_th_parser

std::unique_ptr< TemperatureProperties >	h_mom_temp

std::unique_ptr< VelocityProperties >	h_mom_vel

Detailed Description

WarpXFluidContainer is the base class from which all concrete fluid container classes derive.

WarpXFluidContainer contains the main functions for initialization, interaction with the grid (field gather and current deposition), fluid source and push, advective update and updates for non-inertial terms.

Constructor & Destructor Documentation

◆ WarpXFluidContainer() [1/3]

WarpXFluidContainer::WarpXFluidContainer	(	int	ispecies,
		const std::string &	name )

◆ ~WarpXFluidContainer()

WarpXFluidContainer::~WarpXFluidContainer ( )

default

◆ WarpXFluidContainer() [2/3]

WarpXFluidContainer::WarpXFluidContainer ( WarpXFluidContainer const & )

delete

◆ WarpXFluidContainer() [3/3]

WarpXFluidContainer::WarpXFluidContainer ( WarpXFluidContainer && )

default

Member Function Documentation

◆ AdvectivePush_Muscl()

void WarpXFluidContainer::AdvectivePush_Muscl	(	ablastr::fields::MultiFabRegister &	m_fields,
		int	lev )

Advective term, cold-rel. fluids.

AdvectivePush_Muscl takes a single timestep (dt) of the cold relativistic fluid equations using a Muscl-Handcock scheme

Parameters

	m_fields	reference to MultiFab register storing all fields
[in]	lev	refinement level

◆ AllocateLevelMFs()

void WarpXFluidContainer::AllocateLevelMFs	(	ablastr::fields::MultiFabRegister &	m_fields,
		const amrex::BoxArray &	ba,
		const amrex::DistributionMapping &	dm,
		int	lev ) const

◆ ApplyBcFluidsAndComms()

void WarpXFluidContainer::ApplyBcFluidsAndComms	(	ablastr::fields::MultiFabRegister &	m_fields,
		int	lev )

Apply non-periodic BC to fluids and communicate boundaries.

Apply (non-periodic) BC on the fluids (needed for spatial derivative), and communicate N, NU at boundaries

Parameters

	m_fields	reference to MultiFab register storing all fields
[in]	lev	refinement level

◆ centrifugal_source_rz()

void WarpXFluidContainer::centrifugal_source_rz	(	ablastr::fields::MultiFabRegister &	m_fields,
		int	lev )

Centrifugal source term.

centrifugal_source_rz adds contributions due to curvature acceleration for a single timestep using an SSP-RK3 timestep for RZ specifically

Parameters

	m_fields	reference to MultiFab register storing all fields
[in]	lev	refinement level

◆ DepositCharge()

void WarpXFluidContainer::DepositCharge	(	ablastr::fields::MultiFabRegister &	m_fields,
		amrex::MultiFab &	rho,
		int	lev,
		int	icomp = 0 )

Deposit fluid charge density.

DepositCharge interpolates the fluid charge density onto the Yee grid and sums the contributions to the particle charge density

Parameters

	m_fields	reference to MultiFab register storing all fields
[in,out]	rho	charge density MultiFab.
[in]	lev	refinement level
[in]	icomp	Fourth component index of the rho MultiFab to deposit in

◆ DepositCurrent()

void WarpXFluidContainer::DepositCurrent	(	ablastr::fields::MultiFabRegister &	m_fields,
		amrex::MultiFab &	jx,
		amrex::MultiFab &	jy,
		amrex::MultiFab &	jz,
		int	lev )

Deposit fluid current density.

DepositCurrent interpolates the fluid current density comps. onto the Yee grid and sums the contributions to the particle current density

Parameters

[in,out]	m_fields	MultiFab register of fields
[in,out]	jx	current density MultiFab x comp.
[in,out]	jy	current density MultiFab y comp.
[in,out]	jz	current density MultiFab z comp.
[in]	lev	refinement level

◆ Evolve()

void WarpXFluidContainer::Evolve	(	ablastr::fields::MultiFabRegister &	fields,
		int	lev,
		const std::string &	current_fp_string,
		amrex::Real	cur_time,
		bool	skip_deposition = false )

Evolve updates a single timestep (dt) of the cold relativistic fluid equations

◆ GatherAndPush()

void WarpXFluidContainer::GatherAndPush	(	ablastr::fields::MultiFabRegister &	m_fields,
		const amrex::MultiFab &	Ex,
		const amrex::MultiFab &	Ey,
		const amrex::MultiFab &	Ez,
		const amrex::MultiFab &	Bx,
		const amrex::MultiFab &	By,
		const amrex::MultiFab &	Bz,
		amrex::Real	t,
		int	lev )

Lorentz Momentum Source.

GatherAndPush introduces the Lorentz term in the cold relativistic fluid equations for a single timestep (dt) using Higuera and Cary Push

Parameters

[in,out]	m_fields	MultiFab register of fields
[in]	Ex	Yee electric field (x)
[in]	Ey	Yee electric field (y)
[in]	Ez	Yee electric field (z)
[in]	Bx	Yee magnetic field (x)
[in]	By	Yee magnetic field (y)
[in]	Bz	Yee magnetic field (z)
[in]	t	Current time
[in]	lev	refinement level

◆ getCharge()

amrex::Real WarpXFluidContainer::getCharge ( ) const

inlinenodiscard

◆ getMass()

amrex::Real WarpXFluidContainer::getMass ( ) const

inlinenodiscard

◆ InitData()

void WarpXFluidContainer::InitData	(	ablastr::fields::MultiFabRegister &	m_fields,
		amrex::Box	init_box,
		amrex::Real	cur_time,
		int	lev,
		const amrex::Geometry &	geom_lev,
		amrex::Real	gamma_boost,
		amrex::Real	beta_boost )

◆ operator=() [1/2]

WarpXFluidContainer & WarpXFluidContainer::operator= ( WarpXFluidContainer && )

default

◆ operator=() [2/2]

WarpXFluidContainer & WarpXFluidContainer::operator= ( WarpXFluidContainer const & )

delete

◆ ReadParameters()

void WarpXFluidContainer::ReadParameters ( )

Member Data Documentation

◆ charge

amrex::Real WarpXFluidContainer::charge

protected

◆ d_inj_mom

InjectorMomentum* WarpXFluidContainer::d_inj_mom = nullptr

protected

◆ d_inj_rho

InjectorDensity* WarpXFluidContainer::d_inj_rho = nullptr

protected

◆ density_parser

std::unique_ptr<amrex::Parser> WarpXFluidContainer::density_parser

protected

◆ do_not_deposit

int WarpXFluidContainer::do_not_deposit = 0

protected

◆ do_not_gather

int WarpXFluidContainer::do_not_gather = 0

protected

◆ do_not_push

int WarpXFluidContainer::do_not_push = 0

protected

◆ h_inj_mom

std::unique_ptr<InjectorMomentum,InjectorMomentumDeleter> WarpXFluidContainer::h_inj_mom

protected

◆ h_inj_rho

std::unique_ptr<InjectorDensity,InjectorDensityDeleter> WarpXFluidContainer::h_inj_rho

protected

◆ h_mom_temp

std::unique_ptr<TemperatureProperties> WarpXFluidContainer::h_mom_temp

protected

◆ h_mom_vel

std::unique_ptr<VelocityProperties> WarpXFluidContainer::h_mom_vel

protected

◆ m_B_ext_s

std::string WarpXFluidContainer::m_B_ext_s = "none"

protected

◆ m_Bx_parser

std::unique_ptr<amrex::Parser> WarpXFluidContainer::m_Bx_parser

protected

◆ m_Bxfield_parser

amrex::ParserExecutor<4> WarpXFluidContainer::m_Bxfield_parser

protected

◆ m_By_parser

std::unique_ptr<amrex::Parser> WarpXFluidContainer::m_By_parser

protected

◆ m_Byfield_parser

amrex::ParserExecutor<4> WarpXFluidContainer::m_Byfield_parser

protected

◆ m_Bz_parser

std::unique_ptr<amrex::Parser> WarpXFluidContainer::m_Bz_parser

protected

◆ m_Bzfield_parser

amrex::ParserExecutor<4> WarpXFluidContainer::m_Bzfield_parser

protected

◆ m_E_ext_s

std::string WarpXFluidContainer::m_E_ext_s = "none"

protected

◆ m_Ex_parser

std::unique_ptr<amrex::Parser> WarpXFluidContainer::m_Ex_parser

protected

◆ m_Exfield_parser

amrex::ParserExecutor<4> WarpXFluidContainer::m_Exfield_parser

protected

◆ m_Ey_parser

std::unique_ptr<amrex::Parser> WarpXFluidContainer::m_Ey_parser

protected

◆ m_Eyfield_parser

amrex::ParserExecutor<4> WarpXFluidContainer::m_Eyfield_parser

protected

◆ m_Ez_parser

std::unique_ptr<amrex::Parser> WarpXFluidContainer::m_Ez_parser

protected

◆ m_Ezfield_parser

amrex::ParserExecutor<4> WarpXFluidContainer::m_Ezfield_parser

protected

◆ mass

amrex::Real WarpXFluidContainer::mass

protected

◆ MultiFluidContainer

friend WarpXFluidContainer::MultiFluidContainer

◆ name_mf_N

std::string WarpXFluidContainer::name_mf_N = "fluid_density_"+species_name

◆ name_mf_NU

std::string WarpXFluidContainer::name_mf_NU = "fluid_momentum_density_"+species_name

◆ physical_species

PhysicalSpecies WarpXFluidContainer::physical_species

protected

◆ species_id

int WarpXFluidContainer::species_id

protected

◆ species_name

std::string WarpXFluidContainer::species_name

protected

◆ ux_parser

std::unique_ptr<amrex::Parser> WarpXFluidContainer::ux_parser

protected

◆ ux_th_parser

std::unique_ptr<amrex::Parser> WarpXFluidContainer::ux_th_parser

protected

◆ uy_parser

std::unique_ptr<amrex::Parser> WarpXFluidContainer::uy_parser

protected

◆ uy_th_parser

std::unique_ptr<amrex::Parser> WarpXFluidContainer::uy_th_parser

protected

◆ uz_parser

std::unique_ptr<amrex::Parser> WarpXFluidContainer::uz_parser

protected

◆ uz_th_parser

std::unique_ptr<amrex::Parser> WarpXFluidContainer::uz_th_parser

protected

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

/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6270/Source/Fluids/WarpXFluidContainer.H
/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6270/Source/Fluids/WarpXFluidContainer.cpp

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WarpXFluidContainer() [1/3]

◆ ~WarpXFluidContainer()

◆ WarpXFluidContainer() [2/3]

◆ WarpXFluidContainer() [3/3]

Member Function Documentation

◆ AdvectivePush_Muscl()

◆ AllocateLevelMFs()

◆ ApplyBcFluidsAndComms()

◆ centrifugal_source_rz()

◆ DepositCharge()

◆ DepositCurrent()

◆ Evolve()

◆ GatherAndPush()

◆ getCharge()

◆ getMass()

◆ InitData()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ReadParameters()

Member Data Documentation

◆ charge

◆ d_inj_mom

◆ d_inj_rho

◆ density_parser

◆ do_not_deposit

◆ do_not_gather

◆ do_not_push

◆ h_inj_mom

◆ h_inj_rho

◆ h_mom_temp

◆ h_mom_vel

◆ m_B_ext_s

◆ m_Bx_parser

◆ m_Bxfield_parser

◆ m_By_parser

◆ m_Byfield_parser

◆ m_Bz_parser

◆ m_Bzfield_parser

◆ m_E_ext_s

◆ m_Ex_parser

◆ m_Exfield_parser

◆ m_Ey_parser

◆ m_Eyfield_parser

◆ m_Ez_parser

◆ m_Ezfield_parser

◆ mass

◆ MultiFluidContainer

◆ name_mf_N

◆ name_mf_NU

◆ physical_species

◆ species_id

◆ species_name

◆ ux_parser

◆ ux_th_parser

◆ uy_parser

◆ uy_th_parser

◆ uz_parser

◆ uz_th_parser