SimulationDomain< flt > Class Template Reference

Public Types
using	vec = sycl::vec< flt, 3 >
using	vec_box = std::tuple< vec, vec >

Public Member Functions
	SimulationDomain (const BCType &boundary_type, vec min, vec max)
bool	has_outdomain_object ()
void	check_boundary ()
void	set_box (const vec_box &b)
vec	get_periodicity_vector () const
void	set_periodic_search_range (u32_3 min, u32_3 max)

Public Attributes
BCType	boundary_type
ALignedAxisBoundingBox< flt >	box_bc
std::optional< u32_3 >	periodic_search_min_vec
std::optional< u32_3 >	periodic_search_max_vec

Detailed Description

template<class flt>
class SimulationDomain< flt >

Definition at line 27 of file simulation_domain.hpp.

Member Typedef Documentation

vec

template<class flt >

using SimulationDomain< flt >::vec = sycl::vec<flt, 3>

Definition at line 31 of file simulation_domain.hpp.

vec_box

template<class flt >

using SimulationDomain< flt >::vec_box = std::tuple<vec, vec>

Definition at line 32 of file simulation_domain.hpp.

Constructor & Destructor Documentation

SimulationDomain()

template<class flt >

SimulationDomain< flt >::SimulationDomain ( const BCType &  boundary_type, vec  min, vec  max  )

inline

Definition at line 39 of file simulation_domain.hpp.

Member Function Documentation

check_boundary()

template<class flt >

void SimulationDomain< flt >::check_boundary ( )

inline

Definition at line 61 of file simulation_domain.hpp.

get_periodicity_vector()

template<class flt >

vec SimulationDomain< flt >::get_periodicity_vector ( ) const

inline

Definition at line 92 of file simulation_domain.hpp.

has_outdomain_object()

template<class flt >

bool SimulationDomain< flt >::has_outdomain_object ( )

inline

Definition at line 44 of file simulation_domain.hpp.

set_box()

template<class flt >

void SimulationDomain< flt >::set_box ( const vec_box &  b )

inline

Definition at line 88 of file simulation_domain.hpp.

set_periodic_search_range()

template<class flt >

void SimulationDomain< flt >::set_periodic_search_range ( u32_3  min, u32_3  max  )

inline

Definition at line 107 of file simulation_domain.hpp.

Member Data Documentation

boundary_type

template<class flt >

BCType SimulationDomain< flt >::boundary_type

Definition at line 29 of file simulation_domain.hpp.

box_bc

template<class flt >

ALignedAxisBoundingBox<flt> SimulationDomain< flt >::box_bc

Definition at line 34 of file simulation_domain.hpp.

periodic_search_max_vec

template<class flt >

std::optional<u32_3> SimulationDomain< flt >::periodic_search_max_vec

Definition at line 37 of file simulation_domain.hpp.

periodic_search_min_vec

template<class flt >

std::optional<u32_3> SimulationDomain< flt >::periodic_search_min_vec

Definition at line 36 of file simulation_domain.hpp.

---

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

• shamrock/include/shamrock/legacy/patch/simulation_domain.hpp