fenris 0.0.21

A library for advanced finite element computations in Rust
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
use crate::connectivity::Connectivity;
use crate::mesh::Mesh;
use crate::nalgebra::allocator::Allocator;
use crate::nalgebra::{DMatrix, DVector, DVectorSliceMut};
use crate::nalgebra::{DMatrixSliceMut, DefaultAllocator, DimName, Scalar};
use crate::Real;

mod elliptic;
mod mass;
mod quadrature_table;
mod source;

pub use elliptic::*;
pub use mass::*;
pub use quadrature_table::*;
pub use source::*;

pub trait ElementConnectivityAssembler {
    fn solution_dim(&self) -> usize;

    fn num_elements(&self) -> usize;

    fn num_nodes(&self) -> usize;

    fn element_node_count(&self, element_index: usize) -> usize;

    fn populate_element_nodes(&self, output: &mut [usize], element_index: usize);

    /// Returns an adapter that modifies element node indices according to the provided function.
    ///
    /// In general, changing the node indices is often accompanied by a change in the total number of nodes.
    /// Therefore the new total number of nodes has to be provided.
    ///
    /// This is often used to enlarge the index space and populate only parts of a matrix.
    /// For example, we might use an element assembler for a single body and offset its indices so that
    /// we can assemble directly into a larger matrix containing the results of multiple bodies.
    fn map_element_nodes<F>(self, new_num_nodes: usize, f: F) -> MapElementNodes<Self, F>
    where
        Self: Sized,
    {
        MapElementNodes {
            assembler: self,
            function: f,
            num_nodes: new_num_nodes,
        }
    }
}

impl<T, D, C> ElementConnectivityAssembler for Mesh<T, D, C>
where
    T: Scalar,
    D: DimName,
    C: Connectivity,
    DefaultAllocator: Allocator<T, D>,
{
    fn solution_dim(&self) -> usize {
        1
    }

    fn num_elements(&self) -> usize {
        self.connectivity().len()
    }

    fn num_nodes(&self) -> usize {
        self.vertices().len()
    }

    fn element_node_count(&self, element_index: usize) -> usize {
        self.connectivity()[element_index].vertex_indices().len()
    }

    fn populate_element_nodes(&self, output: &mut [usize], element_index: usize) {
        output.copy_from_slice(self.connectivity()[element_index].vertex_indices());
    }
}

pub trait ElementMatrixAssembler<T: Scalar>: ElementConnectivityAssembler {
    fn assemble_element_matrix_into(&self, element_index: usize, output: DMatrixSliceMut<T>) -> eyre::Result<()>;

    fn assemble_element_matrix(&self, element_index: usize) -> eyre::Result<DMatrix<T>>
    where
        T: Real,
    {
        let ndof = self.solution_dim() * self.element_node_count(element_index);
        let mut output = DMatrix::zeros(ndof, ndof);
        self.assemble_element_matrix_into(element_index, DMatrixSliceMut::from(&mut output))?;
        Ok(output)
    }

    fn transform_element_matrix<Transformation>(
        self,
        transformation: Transformation,
    ) -> TransformElementMatrix<Self, Transformation>
    where
        Self: Sized,
        Transformation: Fn(DMatrixSliceMut<T>) -> eyre::Result<()>,
    {
        TransformElementMatrix {
            assembler: self,
            function: transformation,
        }
    }
}

pub trait ElementVectorAssembler<T: Scalar>: ElementConnectivityAssembler {
    fn assemble_element_vector_into(&self, element_index: usize, output: DVectorSliceMut<T>) -> eyre::Result<()>;

    fn assemble_element_vector(&self, element_index: usize) -> eyre::Result<DVector<T>>
    where
        T: Real,
    {
        let ndof = self.solution_dim() * self.element_node_count(element_index);
        let mut output = DVector::zeros(ndof);
        self.assemble_element_vector_into(element_index, DVectorSliceMut::from(&mut output))?;
        Ok(output)
    }

    fn transform_element_vector<Transformation>(
        self,
        transformation: Transformation,
    ) -> TransformElementVector<Self, Transformation>
    where
        Self: Sized,
        Transformation: Fn(DVectorSliceMut<T>) -> eyre::Result<()>,
    {
        TransformElementVector {
            assembler: self,
            function: transformation,
        }
    }
}

pub trait ElementScalarAssembler<T: Scalar>: ElementConnectivityAssembler {
    fn assemble_element_scalar(&self, element_index: usize) -> eyre::Result<T>;

    fn transform_element_scalar<Transformation>(
        self,
        transformation: Transformation,
    ) -> TransformElementScalar<Self, Transformation>
    where
        Self: Sized,
        Transformation: Fn(T) -> eyre::Result<T>,
    {
        TransformElementScalar {
            assembler: self,
            function: transformation,
        }
    }
}

#[derive(Debug, Clone)]
pub struct AggregateElementAssembler<'a, ElementAssembler> {
    assemblers: &'a [ElementAssembler],
    solution_dim: usize,
    num_elements: usize,
    num_nodes: usize,
    element_offsets: Vec<usize>,
}

impl<'a, ElementAssembler> AggregateElementAssembler<'a, ElementAssembler>
where
    ElementAssembler: ElementConnectivityAssembler,
{
    /// Constructs a new aggregate element assembler from a slice of assemblers.
    ///
    /// Te
    ///
    /// # Panics
    ///
    /// - Panics if the slice of assemblers is empty.
    /// - Panics if the assemblers do not all have the same solution dimension.
    pub fn from_assemblers(assemblers: &'a [ElementAssembler]) -> Self {
        assert!(!assemblers.is_empty(), "Must have at least one assembler in aggregate");
        let solution_dim = assemblers[0].solution_dim();
        let num_nodes = assemblers[0].num_nodes();
        assert!(
            assemblers
                .iter()
                .all(|assembler| assembler.solution_dim() == solution_dim),
            "All assemblers must have the same solution dimension"
        );
        assert!(
            assemblers
                .iter()
                .all(|assembler| assembler.num_nodes() == num_nodes),
            "All assemblers must share the same node index space (same num_nodes)"
        );

        let mut num_total_elements = 0;
        let mut element_offsets = Vec::with_capacity(assemblers.len());
        for assembler in assemblers {
            element_offsets.push(num_total_elements);
            num_total_elements += assembler.num_elements();
        }

        Self {
            assemblers,
            solution_dim,
            element_offsets,
            num_elements: num_total_elements,
            num_nodes: num_nodes,
        }
    }

    fn find_assembler_and_offset_for_element_index(&self, element_index: usize) -> (&ElementAssembler, usize) {
        assert!(element_index <= self.num_elements);
        let assembler_idx = match self.element_offsets.binary_search(&element_index) {
            Ok(idx) => idx,
            Err(idx) => idx - 1,
        };
        (&self.assemblers[assembler_idx], self.element_offsets[assembler_idx])
    }
}

impl<'a, ElementAssembler> ElementConnectivityAssembler for AggregateElementAssembler<'a, ElementAssembler>
where
    ElementAssembler: ElementConnectivityAssembler,
{
    fn solution_dim(&self) -> usize {
        self.solution_dim
    }

    fn num_elements(&self) -> usize {
        self.num_elements
    }

    fn num_nodes(&self) -> usize {
        self.num_nodes
    }

    fn element_node_count(&self, aggregate_element_index: usize) -> usize {
        let (assembler, element_offset) = self.find_assembler_and_offset_for_element_index(aggregate_element_index);
        assembler.element_node_count(aggregate_element_index - element_offset)
    }

    fn populate_element_nodes(&self, output: &mut [usize], aggregate_element_index: usize) {
        let (assembler, element_offset) = self.find_assembler_and_offset_for_element_index(aggregate_element_index);
        assembler.populate_element_nodes(output, aggregate_element_index - element_offset)
    }
}

impl<'a, T, ElementAssembler> ElementScalarAssembler<T> for AggregateElementAssembler<'a, ElementAssembler>
where
    T: Scalar,
    ElementAssembler: ElementScalarAssembler<T>,
{
    fn assemble_element_scalar(&self, aggregate_element_index: usize) -> eyre::Result<T> {
        let (assembler, element_offset) = self.find_assembler_and_offset_for_element_index(aggregate_element_index);
        assembler.assemble_element_scalar(aggregate_element_index - element_offset)
    }
}

impl<'a, T, ElementAssembler> ElementVectorAssembler<T> for AggregateElementAssembler<'a, ElementAssembler>
where
    T: Scalar,
    ElementAssembler: ElementVectorAssembler<T>,
{
    fn assemble_element_vector_into(
        &self,
        aggregate_element_index: usize,
        output: DVectorSliceMut<T>,
    ) -> eyre::Result<()> {
        let (assembler, element_offset) = self.find_assembler_and_offset_for_element_index(aggregate_element_index);
        assembler.assemble_element_vector_into(aggregate_element_index - element_offset, output)
    }
}

impl<'a, T, ElementAssembler> ElementMatrixAssembler<T> for AggregateElementAssembler<'a, ElementAssembler>
where
    T: Scalar,
    ElementAssembler: ElementMatrixAssembler<T>,
{
    fn assemble_element_matrix_into(
        &self,
        aggregate_element_index: usize,
        output: DMatrixSliceMut<T>,
    ) -> eyre::Result<()> {
        let (assembler, element_offset) = self.find_assembler_and_offset_for_element_index(aggregate_element_index);
        assembler.assemble_element_matrix_into(aggregate_element_index - element_offset, output)
    }
}

#[derive(Debug, Clone)]
pub struct TransformElementScalar<Assembler, Transformation> {
    assembler: Assembler,
    function: Transformation,
}

#[derive(Debug, Clone)]
pub struct TransformElementVector<Assembler, Transformation> {
    assembler: Assembler,
    function: Transformation,
}

#[derive(Debug, Clone)]
pub struct TransformElementMatrix<Assembler, Transformation> {
    assembler: Assembler,
    function: Transformation,
}

#[derive(Debug, Clone)]
pub struct MapElementNodes<Assembler, F> {
    assembler: Assembler,
    function: F,
    num_nodes: usize,
}

impl<Assembler, F> ElementConnectivityAssembler for MapElementNodes<Assembler, F>
where
    Assembler: ElementConnectivityAssembler,
    F: Fn(usize) -> usize,
{
    fn solution_dim(&self) -> usize {
        self.assembler.solution_dim()
    }

    fn num_elements(&self) -> usize {
        self.assembler.num_elements()
    }

    fn num_nodes(&self) -> usize {
        self.num_nodes
    }

    fn element_node_count(&self, element_index: usize) -> usize {
        self.assembler.element_node_count(element_index)
    }

    fn populate_element_nodes(&self, output: &mut [usize], element_index: usize) {
        self.assembler.populate_element_nodes(output, element_index);
        for idx in output {
            *idx = (self.function)(*idx);
        }
    }
}

/// Delegate "passthrough" impls to a struct field for generic transformation types
macro_rules! delegate {
    (impl<$delegate_type:ident, $additional_type:ident>
     ElementConnectivityAssembler for $type:ty
     => $self:ident.$delegate_var:ident
     where $($bounds:tt)*) => {
        impl<$delegate_type, $additional_type> ElementConnectivityAssembler for $type
        where
            $delegate_type: ElementConnectivityAssembler,
            $($bounds)*
        {
            fn solution_dim(&$self) -> usize {
                $self.$delegate_var.solution_dim()
            }

            fn num_elements(&$self) -> usize {
                $self.$delegate_var.num_elements()
            }

            fn num_nodes(&$self) -> usize {
                $self.$delegate_var.num_nodes()
            }

            fn element_node_count(&$self, element_index: usize) -> usize {
                $self.$delegate_var.element_node_count(element_index)
            }

            fn populate_element_nodes(&$self, output: &mut [usize], element_index: usize) {
                $self.$delegate_var.populate_element_nodes(output, element_index)
            }
        }
    };
    (impl<$delegate_type:ident, $additional_type:ident>
     ElementScalarAssembler<$scalar:ident> for $type:ty
     => $self:ident.$delegate_var:ident
     where $($bounds:tt)*) => {
        impl<$scalar, $delegate_type, $additional_type> ElementScalarAssembler<$scalar> for $type
        where
            T: Scalar,
            $delegate_type: ElementScalarAssembler<$scalar>,
            $($bounds)*
        {
            fn assemble_element_scalar(&$self, element_index: usize) -> eyre::Result<$scalar> {
                $self.$delegate_var.assemble_element_scalar(element_index)
            }
        }
    };
    (impl<$delegate_type:ident, $additional_type:ident>
     ElementVectorAssembler<$scalar:ident> for $type:ty
     => $self:ident.$delegate_var:ident
     where $($bounds:tt)*) => {
        impl<$scalar, $delegate_type, $additional_type> ElementVectorAssembler<$scalar> for $type
        where
            T: Scalar,
            $delegate_type: ElementVectorAssembler<$scalar>,
            $($bounds)*
        {
            fn assemble_element_vector_into(
                &$self,
                element_index: usize,
                output: DVectorSliceMut<$scalar>)
            -> eyre::Result<()> {
                $self.$delegate_var.assemble_element_vector_into(element_index, output)
            }
        }
    };
    (impl<$delegate_type:ident, $additional_type:ident>
     ElementMatrixAssembler<$scalar:ident> for $type:ty
     => $self:ident.$delegate_var:ident
     where $($bounds:tt)*) => {
        impl<$scalar, $delegate_type, $additional_type> ElementMatrixAssembler<$scalar> for $type
        where
            T: Scalar,
            $delegate_type: ElementMatrixAssembler<$scalar>,
            $($bounds)*
        {
            fn assemble_element_matrix_into(
                &$self,
                element_index: usize,
                output: DMatrixSliceMut<$scalar>)
            -> eyre::Result<()> {
                $self.$delegate_var.assemble_element_matrix_into(element_index, output)
            }
        }
    };
    // This branch allows us to use all of the preceding matchers without having a trailing `where` in the macro call
    (impl<$delegate_type:ident, $additional_type:ident>
     $trait_name:ident$(<$scalar:ident>)? for $type:ty
     => $self:ident.$delegate_var:ident) => {
        delegate!(impl<$delegate_type, $additional_type> $trait_name $(<$scalar>)? for $type
                  => $self.$delegate_var where);
    };
}

delegate!(impl<Assembler, Transformation> ElementConnectivityAssembler
    for TransformElementScalar<Assembler, Transformation>
    => self.assembler);

delegate!(impl<Assembler, Transformation> ElementConnectivityAssembler
    for TransformElementVector<Assembler, Transformation>
    => self.assembler);

delegate!(impl<Assembler, Transformation> ElementConnectivityAssembler
    for TransformElementMatrix<Assembler, Transformation>
    => self.assembler);

delegate!(impl<Assembler, Transformation> ElementScalarAssembler<T>
    for TransformElementVector<Assembler, Transformation>
    => self.assembler);

delegate!(impl<Assembler, Transformation> ElementScalarAssembler<T>
    for TransformElementMatrix<Assembler, Transformation>
    => self.assembler);

delegate!(impl<Assembler, F> ElementScalarAssembler<T>
    for MapElementNodes<Assembler, F>
    => self.assembler
    where F: Fn(usize) -> usize);

delegate!(impl<Assembler, Transformation> ElementVectorAssembler<T>
    for TransformElementMatrix<Assembler, Transformation>
    => self.assembler);

delegate!(impl<Assembler, Transformation> ElementVectorAssembler<T>
    for TransformElementScalar<Assembler, Transformation>
    => self.assembler);

delegate!(impl<Assembler, F> ElementVectorAssembler<T>
    for MapElementNodes<Assembler, F>
    => self.assembler
    where F: Fn(usize) -> usize);

delegate!(impl<Assembler, Transformation> ElementMatrixAssembler<T>
    for TransformElementScalar<Assembler, Transformation>
    => self.assembler);

delegate!(impl<Assembler, Transformation> ElementMatrixAssembler<T>
    for TransformElementVector<Assembler, Transformation>
    => self.assembler);

delegate!(impl<Assembler, F> ElementMatrixAssembler<T>
    for MapElementNodes<Assembler, F>
    => self.assembler
    where F: Fn(usize) -> usize);

impl<T, Transformed, Transformer> ElementScalarAssembler<T> for TransformElementScalar<Transformed, Transformer>
where
    T: Scalar,
    Transformed: ElementScalarAssembler<T>,
    Transformer: Fn(T) -> eyre::Result<T>,
{
    fn assemble_element_scalar(&self, element_index: usize) -> eyre::Result<T> {
        let untransformed = self.assembler.assemble_element_scalar(element_index)?;
        (self.function)(untransformed)
    }
}

impl<T, Transformed, Transformer> ElementVectorAssembler<T> for TransformElementVector<Transformed, Transformer>
where
    T: Scalar,
    Transformed: ElementVectorAssembler<T>,
    Transformer: Fn(DVectorSliceMut<T>) -> eyre::Result<()>,
{
    fn assemble_element_vector_into(&self, element_index: usize, mut output: DVectorSliceMut<T>) -> eyre::Result<()> {
        self.assembler
            .assemble_element_vector_into(element_index, DVectorSliceMut::from(&mut output))?;
        (self.function)(output)
    }
}

impl<T, Transformed, Transformer> ElementMatrixAssembler<T> for TransformElementMatrix<Transformed, Transformer>
where
    T: Scalar,
    Transformed: ElementMatrixAssembler<T>,
    Transformer: Fn(DMatrixSliceMut<T>) -> eyre::Result<()>,
{
    fn assemble_element_matrix_into(&self, element_index: usize, mut output: DMatrixSliceMut<T>) -> eyre::Result<()> {
        self.assembler
            .assemble_element_matrix_into(element_index, DMatrixSliceMut::from(&mut output))?;
        (self.function)(output)
    }
}