ParticleBoundaries Struct Reference

#include <ParticleBoundaries.H>

Classes
struct	ParticleBoundariesData

Public Member Functions
	ParticleBoundaries () noexcept
void	Set_reflect_all_velocities (bool flag)
void	SetAll (ParticleBoundaryType bc)
void	SetThermalVelocity (amrex::Real u_th)
void	SetBoundsX (ParticleBoundaryType bc_lo, ParticleBoundaryType bc_hi)
void	SetBoundsY (ParticleBoundaryType bc_lo, ParticleBoundaryType bc_hi)
void	SetBoundsZ (ParticleBoundaryType bc_lo, ParticleBoundaryType bc_hi)
bool	CheckAll (ParticleBoundaryType bc) const
void	BuildReflectionModelParsers ()

Public Attributes
std::string	reflection_model_xlo_str = "0.0"
std::string	reflection_model_xhi_str = "0.0"
std::string	reflection_model_ylo_str = "0.0"
std::string	reflection_model_yhi_str = "0.0"
std::string	reflection_model_zlo_str = "0.0"
std::string	reflection_model_zhi_str = "0.0"
std::unique_ptr< amrex::Parser >	reflection_model_xlo_parser
std::unique_ptr< amrex::Parser >	reflection_model_xhi_parser
std::unique_ptr< amrex::Parser >	reflection_model_ylo_parser
std::unique_ptr< amrex::Parser >	reflection_model_yhi_parser
std::unique_ptr< amrex::Parser >	reflection_model_zlo_parser
std::unique_ptr< amrex::Parser >	reflection_model_zhi_parser
ParticleBoundariesData	data

Detailed Description

This allows a different boundary condition on each edge of the grid.

Constructor & Destructor Documentation

ParticleBoundaries()

ParticleBoundaries::ParticleBoundaries ( )

noexcept

Member Function Documentation

BuildReflectionModelParsers()

void ParticleBoundaries::BuildReflectionModelParsers

(

)

CheckAll()

bool ParticleBoundaries::CheckAll ( ParticleBoundaryType bc ) const

nodiscard

Set_reflect_all_velocities()

void ParticleBoundaries::Set_reflect_all_velocities

(

bool

flag

)

SetAll()

void ParticleBoundaries::SetAll

(

ParticleBoundaryType

bc

)

SetBoundsX()

void ParticleBoundaries::SetBoundsX	(	ParticleBoundaryType	bc_lo,
		ParticleBoundaryType	bc_hi )

SetBoundsY()

void ParticleBoundaries::SetBoundsY	(	ParticleBoundaryType	bc_lo,
		ParticleBoundaryType	bc_hi )

SetBoundsZ()

void ParticleBoundaries::SetBoundsZ	(	ParticleBoundaryType	bc_lo,
		ParticleBoundaryType	bc_hi )

SetThermalVelocity()

void ParticleBoundaries::SetThermalVelocity

(

amrex::Real

u_th

)

Sets thermal velocity in ParticleBoundariesData 'data.m_uth' to u_th

Member Data Documentation

data

ParticleBoundariesData ParticleBoundaries::data

reflection_model_xhi_parser

std::unique_ptr<amrex::Parser> ParticleBoundaries::reflection_model_xhi_parser

reflection_model_xhi_str

std::string ParticleBoundaries::reflection_model_xhi_str = "0.0"

reflection_model_xlo_parser

std::unique_ptr<amrex::Parser> ParticleBoundaries::reflection_model_xlo_parser

reflection_model_xlo_str

std::string ParticleBoundaries::reflection_model_xlo_str = "0.0"

reflection_model_yhi_parser

std::unique_ptr<amrex::Parser> ParticleBoundaries::reflection_model_yhi_parser

reflection_model_yhi_str

std::string ParticleBoundaries::reflection_model_yhi_str = "0.0"

reflection_model_ylo_parser

std::unique_ptr<amrex::Parser> ParticleBoundaries::reflection_model_ylo_parser

reflection_model_ylo_str

std::string ParticleBoundaries::reflection_model_ylo_str = "0.0"

reflection_model_zhi_parser

std::unique_ptr<amrex::Parser> ParticleBoundaries::reflection_model_zhi_parser

reflection_model_zhi_str

std::string ParticleBoundaries::reflection_model_zhi_str = "0.0"

reflection_model_zlo_parser

std::unique_ptr<amrex::Parser> ParticleBoundaries::reflection_model_zlo_parser

reflection_model_zlo_str

std::string ParticleBoundaries::reflection_model_zlo_str = "0.0"

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/Particles/ParticleBoundaries.H
• /home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/Particles/ParticleBoundaries.cpp