Struct CartesianSubDomain1F32

pub struct CartesianSubDomain1F32 {
    pub voxels: Vec<CartesianVoxel1F32>,
    /* private fields */
}
Expand description

Subdomain of CartesianCuboid1NewF32

The subdomain contains voxels

Fields§

§voxels: Vec<CartesianVoxel1F32>

All voxels contained in this subdomain

Trait Implementations§

§

impl Clone for CartesianSubDomain1F32

§

fn clone(&self) -> CartesianSubDomain1F32

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl Debug for CartesianSubDomain1F32

§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
§

impl<'de> Deserialize<'de> for CartesianSubDomain1F32

§

fn deserialize<__D>( __deserializer: __D, ) -> Result<CartesianSubDomain1F32, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl<C, I> Domain<C, CartesianSubDomain1F32, I> for CartesianCuboid1NewF32
where I: IntoIterator<Item = C>, C: Position<Matrix<f32, Const<1>, Const<1>, ArrayStorage<f32, 1, 1>>>,

§

fn decompose( self, n_subdomains: NonZero<usize>, cells: I, ) -> Result<DecomposedDomain<<CartesianCuboid1NewF32 as Domain<C, CartesianSubDomain1F32, I>>::SubDomainIndex, CartesianSubDomain1F32, 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

Subdomains can be identified by their unique SubDomainIndex. The backend uses this property to construct a mapping (graph) between subdomains.
§

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 CartesianSubDomain1F32

§

fn into_py(self, py: Python<'_>) -> Py<PyAny>

Performs the conversion.
§

impl PyClass for CartesianSubDomain1F32

§

type Frozen = False

Whether the pyclass is frozen. Read more
§

impl PyTypeInfo for CartesianSubDomain1F32

§

const NAME: &'static str = "CartesianSubDomain1F32"

Class name.
§

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.
§

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.
§

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

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

Checks if object is an instance of this type.
§

impl Serialize for CartesianSubDomain1F32

§

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 CartesianSubDomain1F32
where C: Position<Matrix<f32, Const<1>, Const<1>, ArrayStorage<f32, 1, 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<<CartesianSubDomain1F32 as SortCells<C>>::VoxelIndex, BoundaryError>

If given a cell, we can sort this cell into the corresponding sub unit.
§

impl SubDomain for CartesianSubDomain1F32

§

type VoxelIndex = [i64; 1]

Individual Voxels inside each subdomain can be accessed by this index.
§

fn get_neighbor_voxel_indices( &self, index: &<CartesianSubDomain1F32 as SubDomain>::VoxelIndex, ) -> Vec<<CartesianSubDomain1F32 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<<CartesianSubDomain1F32 as SubDomain>::VoxelIndex>

Get all voxel indices of this SubDomain.
§

impl SubDomainMechanics<Matrix<f32, Const<1>, Const<1>, ArrayStorage<f32, 1, 1>>, Matrix<f32, Const<1>, Const<1>, ArrayStorage<f32, 1, 1>>> for CartesianSubDomain1F32

§

fn apply_boundary( &self, pos: &mut Matrix<f32, Const<1>, Const<1>, ArrayStorage<f32, 1, 1>>, velocity: &mut Matrix<f32, Const<1>, Const<1>, ArrayStorage<f32, 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 CartesianSubDomain1F32

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromPyObject<'_> for T
where T: PyClass + Clone,

§

fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<T, PyErr>

Extracts Self from the bound smart pointer obj. Read more
§

impl<'py, T> FromPyObjectBound<'_, 'py> for T
where T: FromPyObject<'py>,

§

fn from_py_object_bound(ob: Borrowed<'_, 'py, PyAny>) -> Result<T, PyErr>

Extracts Self from the bound smart pointer obj. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PyErrArguments for T
where T: IntoPy<Py<PyAny>> + Send + Sync,

§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

§

const NAME: &'static str = <T as PyTypeInfo>::NAME

Name of self. This is used in error messages, for example.
§

fn type_check(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of Self, which may include a subtype. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

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

Checks if self is actually part of its subset T (and can be converted to it).
§

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

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> InteractionInformation for T
where T: Send + Sync + Clone + Debug,

§

impl<T> Ungil for T
where T: Send,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,