WarpX
Loading...
Searching...
No Matches
warpx::boundary_conditions Namespace Reference

Namespaces

namespace  detail
 

Functions

std::pair< amrex::Array< FieldBoundaryType, 3 >, amrex::Array< FieldBoundaryType, 3 > > parse_field_boundaries ()
 Reads the field boundary conditions from the inputfile. Consistency between lower and upper boundary is checked for each direction: if one is periodic, the other must be periodic as well.
 
amrex::Array< bool, 3 > get_periodicity_array (const amrex::Array< FieldBoundaryType, 3 > &field_boundary_lo, const amrex::Array< FieldBoundaryType, 3 > &field_boundary_hi)
 returns a bool array of size AMREX_SPACEDIM where a given element is true if the corresponding boundary conditions are periodic and false otherwise. Consistency between lower and upper boundary is checked for each direction: if one is periodic, the other must be periodic as well.
 

Function Documentation

◆ get_periodicity_array()

amrex::Array< bool, 3 > warpx::boundary_conditions::get_periodicity_array ( const amrex::Array< FieldBoundaryType, 3 > & field_boundary_lo,
const amrex::Array< FieldBoundaryType, 3 > & field_boundary_hi )

returns a bool array of size AMREX_SPACEDIM where a given element is true if the corresponding boundary conditions are periodic and false otherwise. Consistency between lower and upper boundary is checked for each direction: if one is periodic, the other must be periodic as well.

Parameters
[in]field_boundary_lothe field boundary condition for the lower boundary
[in]field_boundary_hithe field boundary condition for the upper boundary
Returns
a bool array of size AMREX_SPACEDIM indicating if field boundary conditions are periodic or not.

◆ parse_field_boundaries()

std::pair< amrex::Array< FieldBoundaryType, 3 >, amrex::Array< FieldBoundaryType, 3 > > warpx::boundary_conditions::parse_field_boundaries ( )

Reads the field boundary conditions from the inputfile. Consistency between lower and upper boundary is checked for each direction: if one is periodic, the other must be periodic as well.

Returns
a pair of amrex::Array<FieldBoundaryType, AMREX_SPACEDIM> containing the boundary conditions for the lower and the upper boundary.