Struct CartesianCuboid3NewF32
pub struct CartesianCuboid3NewF32 {
pub min: [f32; 3],
pub max: [f32; 3],
pub n_voxels: [i64; 3],
pub dx_voxels: [f32; 3],
pub rng_seed: u64,
}
Expand description
Cartesian cuboid in
3D
with float type
f32
Fields§
§min: [f32; 3]
Lower boundary of domain
max: [f32; 3]
Upper boundary of domain
n_voxels: [i64; 3]
Number of voxels in domain along axes
dx_voxels: [f32; 3]
Length of individual voxels in domain
rng_seed: u64
Initial seed from which to generate seeds for voxels
Implementations§
§impl CartesianCuboid3NewF32
impl CartesianCuboid3NewF32
pub fn from_boundaries_and_interaction_ranges(
min: [f32; 3],
max: [f32; 3],
interaction_ranges: [f32; 3],
) -> Result<CartesianCuboid3NewF32, CalcError>
Available on crate feature cpu_os_threads
only.
pub fn from_boundaries_and_interaction_ranges( min: [f32; 3], max: [f32; 3], interaction_ranges: [f32; 3], ) -> Result<CartesianCuboid3NewF32, CalcError>
cpu_os_threads
only.Construct the domain from given lower/upper boundaries and maximum length of interaction ranges along axes.
pub fn from_boundaries_and_n_voxels(
min: [f32; 3],
max: [f32; 3],
n_vox: [usize; 3],
) -> Result<CartesianCuboid3NewF32, CalcError>
Available on crate feature cpu_os_threads
only.
pub fn from_boundaries_and_n_voxels( min: [f32; 3], max: [f32; 3], n_vox: [usize; 3], ) -> Result<CartesianCuboid3NewF32, CalcError>
cpu_os_threads
only.Construct the domain from given lower/upper boundaries and number of voxels along axes.
Trait Implementations§
§impl Clone for CartesianCuboid3NewF32
impl Clone for CartesianCuboid3NewF32
§fn clone(&self) -> CartesianCuboid3NewF32
fn clone(&self) -> CartesianCuboid3NewF32
Returns a copy of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read more§impl Debug for CartesianCuboid3NewF32
impl Debug for CartesianCuboid3NewF32
§impl<'de> Deserialize<'de> for CartesianCuboid3NewF32
impl<'de> Deserialize<'de> for CartesianCuboid3NewF32
§fn deserialize<__D>(
__deserializer: __D,
) -> Result<CartesianCuboid3NewF32, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<CartesianCuboid3NewF32, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
§impl<C, I> Domain<C, CartesianSubDomain3F32, I> for CartesianCuboid3NewF32where
I: IntoIterator<Item = C>,
C: Position<Matrix<f32, Const<3>, Const<1>, ArrayStorage<f32, 3, 1>>>,
impl<C, I> Domain<C, CartesianSubDomain3F32, I> for CartesianCuboid3NewF32where
I: IntoIterator<Item = C>,
C: Position<Matrix<f32, Const<3>, Const<1>, ArrayStorage<f32, 3, 1>>>,
§fn decompose(
self,
n_subdomains: NonZero<usize>,
cells: I,
) -> Result<DecomposedDomain<<CartesianCuboid3NewF32 as Domain<C, CartesianSubDomain3F32, I>>::SubDomainIndex, CartesianSubDomain3F32, C>, DecomposeError>
fn decompose( self, n_subdomains: NonZero<usize>, cells: I, ) -> Result<DecomposedDomain<<CartesianCuboid3NewF32 as Domain<C, CartesianSubDomain3F32, I>>::SubDomainIndex, CartesianSubDomain3F32, C>, DecomposeError>
Much more research must be done to effectively write this function. We should be using more sophisticated functionality based on common known facts for minimizing surface area and number of neighbors. For more information also see
§type SubDomainIndex = usize
type SubDomainIndex = usize
Subdomains can be identified by their unique SubDomainIndex.
The backend uses this property to construct a mapping (graph) between subdomains.
§type VoxelIndex = [i64; 3]
type VoxelIndex = [i64; 3]
Similarly to the SubDomainIndex, voxels can be accessed by
their unique index. The backend will use this information to construct a mapping
(graph) between voxels inside their respective subdomains.
§impl IntoPy<Py<PyAny>> for CartesianCuboid3NewF32
impl IntoPy<Py<PyAny>> for CartesianCuboid3NewF32
§impl PyClass for CartesianCuboid3NewF32
impl PyClass for CartesianCuboid3NewF32
§impl PyTypeInfo for CartesianCuboid3NewF32
impl PyTypeInfo for CartesianCuboid3NewF32
§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
§fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
§fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool
fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool
Checks if
object
is an instance of this type or a subclass of this type.§fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool
fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool
Checks if
object
is an instance of this type.§impl Serialize for CartesianCuboid3NewF32
impl Serialize for CartesianCuboid3NewF32
§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl DerefToPyAny for CartesianCuboid3NewF32
Auto Trait Implementations§
impl Freeze for CartesianCuboid3NewF32
impl RefUnwindSafe for CartesianCuboid3NewF32
impl Send for CartesianCuboid3NewF32
impl Sync for CartesianCuboid3NewF32
impl Unpin for CartesianCuboid3NewF32
impl UnwindSafe for CartesianCuboid3NewF32
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> FromPyObject<'_> for Twhere
T: PyClass + Clone,
impl<T> FromPyObject<'_> for Twhere
T: PyClass + Clone,
§fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<T, PyErr>
fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<T, PyErr>
§impl<'py, T> FromPyObjectBound<'_, 'py> for Twhere
T: FromPyObject<'py>,
impl<'py, T> FromPyObjectBound<'_, 'py> for Twhere
T: FromPyObject<'py>,
§fn from_py_object_bound(ob: Borrowed<'_, 'py, PyAny>) -> Result<T, PyErr>
fn from_py_object_bound(ob: Borrowed<'_, 'py, PyAny>) -> Result<T, PyErr>
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.