Struct CartesianSubDomain1
pub struct CartesianSubDomain1 {
pub voxels: Vec<CartesianVoxel1>,
/* private fields */
}
Expand description
Subdomain of CartesianCuboid1New
The subdomain contains voxels
Fields§
§voxels: Vec<CartesianVoxel1>
All voxels contained in this subdomain
Trait Implementations§
§impl Clone for CartesianSubDomain1
impl Clone for CartesianSubDomain1
§fn clone(&self) -> CartesianSubDomain1
fn clone(&self) -> CartesianSubDomain1
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 CartesianSubDomain1
impl Debug for CartesianSubDomain1
§impl<'de> Deserialize<'de> for CartesianSubDomain1
impl<'de> Deserialize<'de> for CartesianSubDomain1
§fn deserialize<__D>(
__deserializer: __D,
) -> Result<CartesianSubDomain1, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<CartesianSubDomain1, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
§impl<C, I> Domain<C, CartesianSubDomain1, I> for CartesianCuboid1Newwhere
I: IntoIterator<Item = C>,
C: Position<Matrix<f64, Const<1>, Const<1>, ArrayStorage<f64, 1, 1>>>,
impl<C, I> Domain<C, CartesianSubDomain1, I> for CartesianCuboid1Newwhere
I: IntoIterator<Item = C>,
C: Position<Matrix<f64, Const<1>, Const<1>, ArrayStorage<f64, 1, 1>>>,
§fn decompose(
self,
n_subdomains: NonZero<usize>,
cells: I,
) -> Result<DecomposedDomain<<CartesianCuboid1New as Domain<C, CartesianSubDomain1, I>>::SubDomainIndex, CartesianSubDomain1, C>, DecomposeError>
fn decompose( self, n_subdomains: NonZero<usize>, cells: I, ) -> Result<DecomposedDomain<<CartesianCuboid1New as Domain<C, CartesianSubDomain1, I>>::SubDomainIndex, CartesianSubDomain1, 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; 1]
type VoxelIndex = [i64; 1]
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 CartesianSubDomain1
impl IntoPy<Py<PyAny>> for CartesianSubDomain1
§impl PyClass for CartesianSubDomain1
impl PyClass for CartesianSubDomain1
§impl PyTypeInfo for CartesianSubDomain1
impl PyTypeInfo for CartesianSubDomain1
§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 CartesianSubDomain1
impl Serialize for CartesianSubDomain1
§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<C> SortCells<C> for CartesianSubDomain1
impl<C> SortCells<C> for CartesianSubDomain1
§type VoxelIndex = [i64; 1]
type VoxelIndex = [i64; 1]
An index which determines to which next smaller unit the cell should be assigned.
§fn get_voxel_index_of(
&self,
cell: &C,
) -> Result<<CartesianSubDomain1 as SortCells<C>>::VoxelIndex, BoundaryError>
fn get_voxel_index_of( &self, cell: &C, ) -> Result<<CartesianSubDomain1 as SortCells<C>>::VoxelIndex, BoundaryError>
If given a cell, we can sort this cell into the corresponding sub unit.
§impl SubDomain for CartesianSubDomain1
impl SubDomain for CartesianSubDomain1
§type VoxelIndex = [i64; 1]
type VoxelIndex = [i64; 1]
Individual Voxels inside each subdomain can be accessed by this index.
§fn get_neighbor_voxel_indices(
&self,
index: &<CartesianSubDomain1 as SubDomain>::VoxelIndex,
) -> Vec<<CartesianSubDomain1 as SubDomain>::VoxelIndex>
fn get_neighbor_voxel_indices( &self, index: &<CartesianSubDomain1 as SubDomain>::VoxelIndex, ) -> Vec<<CartesianSubDomain1 as SubDomain>::VoxelIndex>
Obtains the neighbor voxels of the specified voxel index. This function behaves similarly
to SortCells::get_voxel_index_of in that it also has to return
indices which are in other SubDomains.
§fn get_all_indices(&self) -> Vec<<CartesianSubDomain1 as SubDomain>::VoxelIndex>
fn get_all_indices(&self) -> Vec<<CartesianSubDomain1 as SubDomain>::VoxelIndex>
Get all voxel indices of this SubDomain.
§impl SubDomainMechanics<Matrix<f64, Const<1>, Const<1>, ArrayStorage<f64, 1, 1>>, Matrix<f64, Const<1>, Const<1>, ArrayStorage<f64, 1, 1>>> for CartesianSubDomain1
impl SubDomainMechanics<Matrix<f64, Const<1>, Const<1>, ArrayStorage<f64, 1, 1>>, Matrix<f64, Const<1>, Const<1>, ArrayStorage<f64, 1, 1>>> for CartesianSubDomain1
§fn apply_boundary(
&self,
pos: &mut Matrix<f64, Const<1>, Const<1>, ArrayStorage<f64, 1, 1>>,
velocity: &mut Matrix<f64, Const<1>, Const<1>, ArrayStorage<f64, 1, 1>>,
) -> Result<(), BoundaryError>
fn apply_boundary( &self, pos: &mut Matrix<f64, Const<1>, Const<1>, ArrayStorage<f64, 1, 1>>, velocity: &mut Matrix<f64, Const<1>, Const<1>, ArrayStorage<f64, 1, 1>>, ) -> Result<(), BoundaryError>
If the subdomain has boundary conditions, this function will enforce them onto the cells.
For the future, we plan to replace this function to additionally obtain information
about the previous and current location of the cell.
impl DerefToPyAny for CartesianSubDomain1
Auto Trait Implementations§
impl Freeze for CartesianSubDomain1
impl RefUnwindSafe for CartesianSubDomain1
impl Send for CartesianSubDomain1
impl Sync for CartesianSubDomain1
impl Unpin for CartesianSubDomain1
impl UnwindSafe for CartesianSubDomain1
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.