Struct CartesianSubDomain3

pub struct CartesianSubDomain3 {
    pub voxels: Vec<CartesianVoxel3>,
    /* private fields */
}

Subdomain of CartesianCuboid3New

The subdomain contains voxels

Fields

voxels: Vec<CartesianVoxel3>

All voxels contained in this subdomain

Trait Implementations

impl Clone for CartesianSubDomain3

fn clone(&self) -> CartesianSubDomain3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CartesianSubDomain3

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CartesianSubDomain3

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C, I> Domain<C, CartesianSubDomain3, I> for CartesianCuboid3New

where I: IntoIterator<Item = C>, C: Position<Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>>,

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

• Wikipedia
• Math StackExchange

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]

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 CartesianSubDomain3

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

Performs the conversion.

impl PyClass for CartesianSubDomain3

type Frozen = False

Whether the pyclass is frozen.

impl PyTypeInfo for CartesianSubDomain3

const NAME: &'static str = "CartesianSubDomain3"

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 CartesianSubDomain3

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.

impl<C> SortCells<C> for CartesianSubDomain3

where C: Position<Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>>,

type VoxelIndex = [i64; 3]

An index which determines to which next smaller unit the cell should be assigned.

fn get_voxel_index_of( &self, cell: &C, ) -> Result<<CartesianSubDomain3 as SortCells<C>>::VoxelIndex, BoundaryError>

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

impl SubDomain for CartesianSubDomain3

type VoxelIndex = [i64; 3]

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

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

Get all voxel indices of this SubDomain.

impl SubDomainMechanics<Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>, Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>> for CartesianSubDomain3

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