[INFO] cloning repository https://github.com/preiter93/rustpde-mpi [INFO] running `Command { std: "git" "-c" "credential.helper=" "-c" "credential.helper=/workspace/cargo-home/bin/git-credential-null" "clone" "--bare" "https://github.com/preiter93/rustpde-mpi" "/workspace/cache/git-repos/https%3A%2F%2Fgithub.com%2Fpreiter93%2Frustpde-mpi", kill_on_drop: false }` [INFO] [stderr] Cloning into bare repository '/workspace/cache/git-repos/https%3A%2F%2Fgithub.com%2Fpreiter93%2Frustpde-mpi'... [INFO] running `Command { std: "git" "rev-parse" "HEAD", kill_on_drop: false }` [INFO] [stdout] 6c89e768a878a4ff35ae1f707d5e2622b5852b4d [INFO] documenting preiter93/rustpde-mpi against master#e1df625306f4136949e02612406f0c60df6008f3 for pr-96676 [INFO] running `Command { std: "git" "clone" "/workspace/cache/git-repos/https%3A%2F%2Fgithub.com%2Fpreiter93%2Frustpde-mpi" "/workspace/builds/worker-61/source", kill_on_drop: false }` [INFO] [stderr] Cloning into '/workspace/builds/worker-61/source'... [INFO] [stderr] done. [INFO] validating manifest of git repo https://github.com/preiter93/rustpde-mpi on toolchain e1df625306f4136949e02612406f0c60df6008f3 [INFO] running `Command { std: "/workspace/cargo-home/bin/cargo" "+e1df625306f4136949e02612406f0c60df6008f3" "metadata" "--manifest-path" "Cargo.toml" "--no-deps", kill_on_drop: false }` [INFO] started tweaking git repo https://github.com/preiter93/rustpde-mpi [INFO] finished tweaking git repo https://github.com/preiter93/rustpde-mpi [INFO] tweaked toml for git repo https://github.com/preiter93/rustpde-mpi written to /workspace/builds/worker-61/source/Cargo.toml [INFO] crate git repo https://github.com/preiter93/rustpde-mpi already has a lockfile, it will not be regenerated [INFO] running `Command { std: "/workspace/cargo-home/bin/cargo" "+e1df625306f4136949e02612406f0c60df6008f3" "fetch" "--manifest-path" "Cargo.toml", kill_on_drop: false }` [INFO] [stderr] Blocking waiting for file lock on package cache [INFO] [stderr] Blocking waiting for file lock on package cache [INFO] [stderr] Downloading crates ... [INFO] [stderr] Downloaded intel-mkl-src v0.6.0+mkl2020.1 [INFO] [stderr] Downloaded hdf5-types v0.8.1 [INFO] [stderr] Downloaded hdf5 v0.8.1 [INFO] [stderr] Downloaded intel-mkl-tool v0.2.0+mkl2020.1 [INFO] [stderr] Downloaded abort_on_panic v2.0.0 [INFO] [stderr] Downloaded libffi v1.0.1 [INFO] [stderr] Downloaded bindgen v0.31.3 [INFO] [stderr] Downloaded hdf5-sys v0.8.1 [INFO] [stderr] Downloaded hdf5-derive v0.8.1 [INFO] [stderr] Downloaded mpi-fork-fnsp v0.6.0 [INFO] [stderr] Downloaded funspace v0.3.0 [INFO] [stderr] Downloaded libc v0.2.110 [INFO] [stderr] Downloaded libffi-sys v1.3.0 [INFO] [stderr] Downloaded curl-sys v0.4.53+curl-7.82.0 [INFO] running `Command { std: "docker" "create" "-v" "/var/lib/crater-agent-workspace/builds/worker-61/target:/opt/rustwide/target:rw,Z" "-v" "/var/lib/crater-agent-workspace/builds/worker-61/source:/opt/rustwide/workdir:ro,Z" "-v" "/var/lib/crater-agent-workspace/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/var/lib/crater-agent-workspace/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "-m" "1610612736" "--user" "0:0" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:d190cb871061d98bc6d0581d85cb2ecb09a0f8a142ba5463de30be9999fc3251" "/opt/rustwide/cargo-home/bin/cargo" "+e1df625306f4136949e02612406f0c60df6008f3" "metadata" "--no-deps" "--format-version=1", kill_on_drop: false }` [INFO] [stdout] e2f32afecd37c3dcf6fa6627eeb9a8f81b010e1f7aad1da71edebf3e1ef63442 [INFO] running `Command { std: "docker" "start" "-a" "e2f32afecd37c3dcf6fa6627eeb9a8f81b010e1f7aad1da71edebf3e1ef63442", kill_on_drop: false }` [INFO] running `Command { std: "docker" "inspect" "e2f32afecd37c3dcf6fa6627eeb9a8f81b010e1f7aad1da71edebf3e1ef63442", kill_on_drop: false }` [INFO] running `Command { std: "docker" "rm" "-f" "e2f32afecd37c3dcf6fa6627eeb9a8f81b010e1f7aad1da71edebf3e1ef63442", kill_on_drop: false }` [INFO] [stdout] e2f32afecd37c3dcf6fa6627eeb9a8f81b010e1f7aad1da71edebf3e1ef63442 [INFO] running `Command { std: "docker" "create" "-v" "/var/lib/crater-agent-workspace/builds/worker-61/target:/opt/rustwide/target:rw,Z" "-v" "/var/lib/crater-agent-workspace/builds/worker-61/source:/opt/rustwide/workdir:ro,Z" "-v" "/var/lib/crater-agent-workspace/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/var/lib/crater-agent-workspace/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "CARGO_INCREMENTAL=0" "-e" "RUST_BACKTRACE=full" "-e" "RUSTDOCFLAGS=--cap-lints=forbid" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "-m" "1610612736" "--user" "0:0" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:d190cb871061d98bc6d0581d85cb2ecb09a0f8a142ba5463de30be9999fc3251" "/opt/rustwide/cargo-home/bin/cargo" "+e1df625306f4136949e02612406f0c60df6008f3" "doc" "--frozen" "--no-deps" "--document-private-items" "--message-format=json", kill_on_drop: false }` [INFO] [stdout] 28a47a6946632d9d032f978892893725012bf2dc3c4af007f1d75faf29c8b5a1 [INFO] running `Command { std: "docker" "start" "-a" "28a47a6946632d9d032f978892893725012bf2dc3c4af007f1d75faf29c8b5a1", kill_on_drop: false }` [INFO] [stderr] Blocking waiting for file lock on package cache [INFO] [stderr] Compiling libc v0.2.110 [INFO] [stderr] Compiling autocfg v1.0.1 [INFO] [stderr] Checking cfg-if v1.0.0 [INFO] [stderr] Compiling libm v0.2.1 [INFO] [stderr] Compiling memchr v2.4.1 [INFO] [stderr] Compiling proc-macro2 v1.0.33 [INFO] [stderr] Checking ppv-lite86 v0.2.15 [INFO] [stderr] Compiling unicode-xid v0.2.2 [INFO] [stderr] Compiling syn v1.0.82 [INFO] [stderr] Compiling serde v1.0.131 [INFO] [stderr] Compiling crossbeam-utils v0.8.5 [INFO] [stderr] Compiling pkg-config v0.3.23 [INFO] [stderr] Checking lazy_static v1.4.0 [INFO] [stderr] Checking scopeguard v1.1.0 [INFO] [stderr] Compiling crossbeam-epoch v0.9.5 [INFO] [stderr] Compiling log v0.4.14 [INFO] [stderr] Compiling glob v0.2.11 [INFO] [stderr] Compiling rayon-core v1.9.1 [INFO] [stderr] Compiling regex-syntax v0.6.25 [INFO] [stderr] Compiling ucd-util v0.1.8 [INFO] [stderr] Compiling libloading v0.4.3 [INFO] [stderr] Compiling regex v0.2.11 [INFO] [stderr] Compiling same-file v1.0.6 [INFO] [stderr] Compiling utf8-ranges v1.0.4 [INFO] [stderr] Compiling unicode-width v0.1.9 [INFO] [stderr] Compiling bindgen v0.31.3 [INFO] [stderr] Compiling ansi_term v0.12.1 [INFO] [stderr] Checking rawpointer v0.2.1 [INFO] [stderr] Compiling strsim v0.8.0 [INFO] [stderr] Compiling bitflags v1.3.2 [INFO] [stderr] Checking either v1.6.1 [INFO] [stderr] Compiling vec_map v0.8.2 [INFO] [stderr] Compiling cfg-if v0.1.10 [INFO] [stderr] Checking smallvec v1.7.0 [INFO] [stderr] Compiling peeking_take_while v0.1.2 [INFO] [stderr] Checking strength_reduce v0.2.3 [INFO] [stderr] Compiling quote v0.3.15 [INFO] [stderr] Compiling libffi-sys v1.3.0 [INFO] [stderr] Compiling lazy_static v0.2.11 [INFO] [stderr] Compiling cc v1.0.72 [INFO] [stderr] Compiling parking_lot_core v0.8.5 [INFO] [stderr] Checking abort_on_panic v2.0.0 [INFO] [stderr] Compiling hdf5-types v0.8.1 [INFO] [stderr] Checking custom_derive v0.1.7 [INFO] [stderr] Checking ascii v1.0.0 [INFO] [stderr] Compiling hdf5 v0.8.1 [INFO] [stderr] Compiling once_cell v1.8.0 [INFO] [stderr] Compiling paste v1.0.6 [INFO] [stderr] Checking instant v0.1.12 [INFO] [stderr] Compiling libloading v0.7.2 [INFO] [stderr] Compiling thread_local v0.3.6 [INFO] [stderr] Checking conv v0.3.3 [INFO] [stderr] Checking matrixmultiply v0.3.2 [INFO] [stderr] Checking lock_api v0.4.5 [INFO] [stderr] Compiling walkdir v2.3.2 [INFO] [stderr] Compiling regex-syntax v0.5.6 [INFO] [stderr] Compiling build-probe-mpi v0.1.1 [INFO] [stderr] Compiling textwrap v0.11.0 [INFO] [stderr] Compiling num-traits v0.2.14 [INFO] [stderr] Compiling memoffset v0.6.5 [INFO] [stderr] Compiling num-integer v0.1.44 [INFO] [stderr] Compiling rayon v1.5.1 [INFO] [stderr] Compiling clang-sys v0.21.2 [INFO] [stderr] Compiling log v0.3.9 [INFO] [stderr] Checking crossbeam-channel v0.5.1 [INFO] [stderr] Compiling aho-corasick v0.7.18 [INFO] [stderr] Compiling aho-corasick v0.6.10 [INFO] [stderr] Checking getrandom v0.2.3 [INFO] [stderr] Checking num_cpus v1.13.0 [INFO] [stderr] Checking cblas-sys v0.1.4 [INFO] [stderr] Checking lapack-sys v0.12.1 [INFO] [stderr] Compiling memchr v1.0.2 [INFO] [stderr] Compiling dirs-sys v0.3.6 [INFO] [stderr] Compiling atty v0.2.14 [INFO] [stderr] Compiling which v1.0.5 [INFO] [stderr] Compiling quote v1.0.10 [INFO] [stderr] Compiling regex v1.5.4 [INFO] [stderr] Compiling nom v3.2.1 [INFO] [stderr] Compiling dirs v3.0.2 [INFO] [stderr] Checking rand_core v0.6.3 [INFO] [stderr] Checking approx v0.4.0 [INFO] [stderr] Compiling clap v2.34.0 [INFO] [stderr] Checking parking_lot v0.11.2 [INFO] [stderr] Checking crossbeam-deque v0.8.1 [INFO] [stderr] Checking rand_chacha v0.3.1 [INFO] [stderr] Checking transpose v0.2.1 [INFO] [stderr] Checking primal-check v0.3.1 [INFO] [stderr] Checking rand v0.8.4 [INFO] [stderr] Compiling cexpr v0.2.3 [INFO] [stderr] Compiling env_logger v0.4.3 [INFO] [stderr] Checking num-complex v0.4.0 [INFO] [stderr] Checking rand_distr v0.4.2 [INFO] [stderr] Checking rustfft v6.0.1 [INFO] [stderr] Checking cauchy v0.4.0 [INFO] [stderr] Checking lapack v0.18.0 [INFO] [stderr] Compiling hdf5-sys v0.8.1 [INFO] [stderr] Checking ndarray v0.15.4 [INFO] [stderr] Compiling thiserror-impl v1.0.30 [INFO] [stderr] Compiling enum_dispatch v0.3.7 [INFO] [stderr] Compiling hdf5-derive v0.8.1 [INFO] [stderr] Checking rustdct v0.7.0 [INFO] [stderr] Checking realfft v3.0.0 [INFO] [stderr] Checking ndarray-rand v0.14.0 [INFO] [stderr] Compiling mpi-fork-fnsp v0.6.0 [INFO] [stderr] Compiling thiserror v1.0.30 [INFO] [stderr] Compiling openblas-build v0.1.1 [INFO] [stderr] Compiling openblas-src v0.10.4 [INFO] [stderr] Checking lax v0.2.0 [INFO] [stderr] Checking ndarray-linalg v0.14.1 [INFO] [stderr] Checking libffi v1.0.1 [INFO] [stderr] Checking funspace v0.3.0 [INFO] [stderr] Documenting rustpde v0.3.0 (/opt/rustwide/workdir) [INFO] [stdout] warning: lint `missing_doc_code_examples` has been renamed to `rustdoc::missing_doc_code_examples` [INFO] [stdout] --> src/lib.rs:146:9 [INFO] [stdout] | [INFO] [stdout] 146 | #![warn(missing_doc_code_examples)] [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^ help: use the new name: `rustdoc::missing_doc_code_examples` [INFO] [stdout] | [INFO] [stdout] = note: `#[warn(renamed_and_removed_lints)]` on by default [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing documentation for a struct field [INFO] [stdout] --> src/solver/poisson.rs:35:5 [INFO] [stdout] | [INFO] [stdout] 35 | pub solver: Box>, [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] | [INFO] [stdout] note: the lint level is defined here [INFO] [stdout] --> src/lib.rs:145:9 [INFO] [stdout] | [INFO] [stdout] 145 | #![warn(missing_docs)] [INFO] [stdout] | ^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing documentation for a struct field [INFO] [stdout] --> src/solver/poisson.rs:36:5 [INFO] [stdout] | [INFO] [stdout] 36 | pub matvec: Vec>>, [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/lib.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! # `rustpde`: Spectral method solver for Navier-Stokes equations [INFO] [stdout] 2 | | //! [INFO] [stdout] 3 | | //! [INFO] [stdout] 4 | | //! # Dependencies [INFO] [stdout] ... | [INFO] [stdout] 143 | | //! [INFO] [stdout] 144 | | //! `cargo doc --open` [INFO] [stdout] | |______________________^ [INFO] [stdout] | [INFO] [stdout] note: the lint level is defined here [INFO] [stdout] --> src/lib.rs:146:9 [INFO] [stdout] | [INFO] [stdout] 146 | #![warn(missing_doc_code_examples)] [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/bases.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! # Bases [INFO] [stdout] 2 | | //! `Funspace` now as independent package [INFO] [stdout] 3 | | //! [INFO] [stdout] 4 | | //! Implemented: [INFO] [stdout] ... | [INFO] [stdout] 9 | | //! - `FourierC2c` (Orthonormal), see [`fourier_c2c()`] [INFO] [stdout] 10 | | //! - `FourierR2c` (Orthonormal), see [`fourier_r2c()`] [INFO] [stdout] | |_______________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! # Multidimensional field of basis functions [INFO] [stdout] 2 | | //! Wrapper around funspace `Space` fields, plus [INFO] [stdout] 3 | | //! let field store *n*-dimensional arrays which [INFO] [stdout] 4 | | //! belong the the physical (v) and spectral (vhat) [INFO] [stdout] 5 | | //! space. [INFO] [stdout] | |__________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field/average.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Implementations of volumetric weight averages [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field/average.rs:6:1 [INFO] [stdout] | [INFO] [stdout] 6 | / impl FieldBase [INFO] [stdout] 7 | | where [INFO] [stdout] 8 | | S: BaseSpace, [INFO] [stdout] 9 | | { [INFO] [stdout] ... | [INFO] [stdout] 59 | | } [INFO] [stdout] 60 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field/io.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Implement io routines for `FieldBase` [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field.rs:74:1 [INFO] [stdout] | [INFO] [stdout] 74 | / impl FieldBase [INFO] [stdout] 75 | | where [INFO] [stdout] 76 | | A: FloatNum, [INFO] [stdout] 77 | | Complex: ScalarOperand, [INFO] [stdout] ... | [INFO] [stdout] 249 | | } [INFO] [stdout] 250 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field.rs:80:5 [INFO] [stdout] | [INFO] [stdout] 80 | /// Return a new field from a given space [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field.rs:92:5 [INFO] [stdout] | [INFO] [stdout] 92 | /// Scale coordinates [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field.rs:102:5 [INFO] [stdout] | [INFO] [stdout] 102 | /// Forward transformation [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field.rs:107:5 [INFO] [stdout] | [INFO] [stdout] 107 | /// Backward transformation [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field.rs:112:5 [INFO] [stdout] | [INFO] [stdout] 112 | /// Transform from composite to orthogonal space [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field.rs:117:5 [INFO] [stdout] | [INFO] [stdout] 117 | /// Transform from orthogonal to composite space [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field.rs:125:5 [INFO] [stdout] | [INFO] [stdout] 125 | /// Gradient [INFO] [stdout] | ^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field.rs:188:5 [INFO] [stdout] | [INFO] [stdout] 188 | / /// Hholtz equation: (I-c*D2) vhat = A f [INFO] [stdout] 189 | | /// [INFO] [stdout] 190 | | /// This function returns I (`mat_a`), D2 (`mat_b`) and [INFO] [stdout] 191 | | /// the optional preconditionar A for a given base. [INFO] [stdout] 192 | | /// [INFO] [stdout] 193 | | /// # Panics [INFO] [stdout] 194 | | /// If ingredients are not defined for a given base. [INFO] [stdout] | |________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field.rs:218:5 [INFO] [stdout] | [INFO] [stdout] 218 | / /// Poisson equation: D2 vhat = A f [INFO] [stdout] 219 | | /// [INFO] [stdout] 220 | | /// This function returns I (`mat_a`), D2 (`mat_b`) and [INFO] [stdout] 221 | | /// the optional preconditionar A for a given base. [INFO] [stdout] ... | [INFO] [stdout] 226 | | /// # Panics [INFO] [stdout] 227 | | /// If ingredients are not defined for a given base. [INFO] [stdout] | |________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! # Multidimensional field of basis functions [INFO] [stdout] 2 | | //! Wrapper around funspace `Space` fields, plus [INFO] [stdout] 3 | | //! let field store *n*-dimensional arrays which [INFO] [stdout] 4 | | //! belong the the physical (v) and spectral (vhat) [INFO] [stdout] 5 | | //! space. [INFO] [stdout] 6 | | //! [INFO] [stdout] 7 | | //! Supports mpi. [INFO] [stdout] | |_________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi/average.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Implementations of volumetric weight averages [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi/average.rs:9:1 [INFO] [stdout] | [INFO] [stdout] 9 | / impl FieldBaseMpi [INFO] [stdout] 10 | | where [INFO] [stdout] 11 | | A: FloatNum + Equivalence + Sum + ScalarOperand, [INFO] [stdout] 12 | | S: BaseSpace + BaseSpaceMpi, [INFO] [stdout] ... | [INFO] [stdout] 85 | | } [INFO] [stdout] 86 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi/average.rs:14:5 [INFO] [stdout] | [INFO] [stdout] 14 | /// Return volumetric weighted average along lane [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi/average.rs:36:5 [INFO] [stdout] | [INFO] [stdout] 36 | / /// Return volumetric weighted average along axis [INFO] [stdout] 37 | | /// [INFO] [stdout] 38 | | /// # Panics [INFO] [stdout] 39 | | /// If the wrong `DecompHandler` was returned, [INFO] [stdout] 40 | | /// which does not match the array size [INFO] [stdout] | |___________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi/average.rs:63:5 [INFO] [stdout] | [INFO] [stdout] 63 | /// Return volumetric weighted average [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi/io.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Implement io routines for `FieldBaseMpi` [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:25:1 [INFO] [stdout] | [INFO] [stdout] 25 | / /// Field struct with mpi support [INFO] [stdout] 26 | | /// [INFO] [stdout] 27 | | /// `v`: ndarray [INFO] [stdout] 28 | | /// [INFO] [stdout] ... | [INFO] [stdout] 67 | | /// from an orthonormal space to its galerkin space (`from_ortho` [INFO] [stdout] 68 | | /// and `to_ortho`). [INFO] [stdout] | |____________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:90:1 [INFO] [stdout] | [INFO] [stdout] 90 | / impl FieldBaseMpi [INFO] [stdout] 91 | | where [INFO] [stdout] 92 | | A: FloatNum, [INFO] [stdout] 93 | | Complex: ScalarOperand, [INFO] [stdout] ... | [INFO] [stdout] 135 | | } [INFO] [stdout] 136 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:96:5 [INFO] [stdout] | [INFO] [stdout] 96 | /// Return a new field from a given space [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:117:5 [INFO] [stdout] | [INFO] [stdout] 117 | /// Scale coordinates [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:127:5 [INFO] [stdout] | [INFO] [stdout] 127 | /// Get coordinates that are local on processor [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:176:1 [INFO] [stdout] | [INFO] [stdout] 176 | / impl FieldBaseMpi [INFO] [stdout] 177 | | where [INFO] [stdout] 178 | | A: FloatNum, [INFO] [stdout] 179 | | Complex: ScalarOperand, [INFO] [stdout] ... | [INFO] [stdout] 299 | | } [INFO] [stdout] 300 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:239:5 [INFO] [stdout] | [INFO] [stdout] 239 | / /// Hholtz equation: (I-c*D2) vhat = A f [INFO] [stdout] 240 | | /// [INFO] [stdout] 241 | | /// This function returns I (`mat_a`), D2 (`mat_b`) and [INFO] [stdout] 242 | | /// the optional preconditionar A for a given base. [INFO] [stdout] 243 | | /// [INFO] [stdout] 244 | | /// # Panics [INFO] [stdout] 245 | | /// If ingredients are not defined for a given base. [INFO] [stdout] | |________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:269:5 [INFO] [stdout] | [INFO] [stdout] 269 | / /// Poisson equation: D2 vhat = A f [INFO] [stdout] 270 | | /// [INFO] [stdout] 271 | | /// This function returns I (`mat_a`), D2 (`mat_b`) and [INFO] [stdout] 272 | | /// the optional preconditionar A for a given base. [INFO] [stdout] ... | [INFO] [stdout] 277 | | /// # Panics [INFO] [stdout] 278 | | /// If ingredients are not defined for a given base. [INFO] [stdout] | |________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:302:1 [INFO] [stdout] | [INFO] [stdout] 302 | / impl FieldBaseMpi [INFO] [stdout] 303 | | where [INFO] [stdout] 304 | | A: FloatNum, [INFO] [stdout] 305 | | Complex: ScalarOperand, [INFO] [stdout] ... | [INFO] [stdout] 477 | | } [INFO] [stdout] 478 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:308:5 [INFO] [stdout] | [INFO] [stdout] 308 | /// Get my processor id [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:313:5 [INFO] [stdout] | [INFO] [stdout] 313 | /// Get my processor id [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:318:5 [INFO] [stdout] | [INFO] [stdout] 318 | /// Get total number of processors [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:323:5 [INFO] [stdout] | [INFO] [stdout] 323 | /// Forward transformation with mpi [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:329:5 [INFO] [stdout] | [INFO] [stdout] 329 | /// Backward transformation with mpi [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:335:5 [INFO] [stdout] | [INFO] [stdout] 335 | /// Transform from composite to orthogonal space [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:340:5 [INFO] [stdout] | [INFO] [stdout] 340 | /// Transform from orthogonal to composite space [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:349:5 [INFO] [stdout] | [INFO] [stdout] 349 | /// Gradient [INFO] [stdout] | ^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:359:5 [INFO] [stdout] | [INFO] [stdout] 359 | / /// Gather distributed data on root (x-pencil, spectral domain) [INFO] [stdout] 360 | | /// [INFO] [stdout] 361 | | /// # Info [INFO] [stdout] 362 | | /// Must be called from mpi processor non-root [INFO] [stdout] | |__________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:367:5 [INFO] [stdout] | [INFO] [stdout] 367 | / /// Gather distributed data on root (x-pencil, spectral domain) [INFO] [stdout] 368 | | /// [INFO] [stdout] 369 | | /// # Info [INFO] [stdout] 370 | | /// Must be called from mpi processor root [INFO] [stdout] | |______________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:379:5 [INFO] [stdout] | [INFO] [stdout] 379 | / /// Gather distributed data on root (y-pencil, physical domain) [INFO] [stdout] 380 | | /// [INFO] [stdout] 381 | | /// # Info [INFO] [stdout] 382 | | /// Must be called from mpi processor non-root [INFO] [stdout] | |__________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:387:5 [INFO] [stdout] | [INFO] [stdout] 387 | / /// Gather distributed data on root (y-pencil, physical domain) [INFO] [stdout] 388 | | /// [INFO] [stdout] 389 | | /// # Info [INFO] [stdout] 390 | | /// Must be called from mpi processor root [INFO] [stdout] | |______________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:398:5 [INFO] [stdout] | [INFO] [stdout] 398 | / /// Send data from root to all processors (y-pencil, physical domain) [INFO] [stdout] 399 | | /// [INFO] [stdout] 400 | | /// # Info [INFO] [stdout] 401 | | /// Must be called from mpi processor non-root [INFO] [stdout] | |__________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:406:5 [INFO] [stdout] | [INFO] [stdout] 406 | / /// Send data from root to all processors (y-pencil, physical domain) [INFO] [stdout] 407 | | /// [INFO] [stdout] 408 | | /// # Info [INFO] [stdout] 409 | | /// Must be called from mpi processor root [INFO] [stdout] | |______________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:418:5 [INFO] [stdout] | [INFO] [stdout] 418 | / /// Send data from root to all processors (x-pencil, spectral domain) [INFO] [stdout] 419 | | /// [INFO] [stdout] 420 | | /// # Info [INFO] [stdout] 421 | | /// Must be called from mpi processor non-root [INFO] [stdout] | |__________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:426:5 [INFO] [stdout] | [INFO] [stdout] 426 | / /// Send data from root to all processors (x-pencil, spectral domain) [INFO] [stdout] 427 | | /// [INFO] [stdout] 428 | | /// # Info [INFO] [stdout] 429 | | /// Must be called from mpi processor root [INFO] [stdout] | |______________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:438:5 [INFO] [stdout] | [INFO] [stdout] 438 | /// Gather distributed data on all participating processors (y-pencil, physical domain) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:446:5 [INFO] [stdout] | [INFO] [stdout] 446 | /// Gather distributed data on all participating processors (x-pencil, spectral domain) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:455:5 [INFO] [stdout] | [INFO] [stdout] 455 | /// Transpose physical data from x to y pencil [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:461:5 [INFO] [stdout] | [INFO] [stdout] 461 | /// Transpose physical data from y to x pencil [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:467:5 [INFO] [stdout] | [INFO] [stdout] 467 | /// Transpose spectral data from x to y pencil [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/field_mpi.rs:473:5 [INFO] [stdout] | [INFO] [stdout] 473 | /// Transpose spectral data from y to x pencil [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! Interface between ndarray and hdf5 for [INFO] [stdout] 2 | | //! easier reading/writing of scalars and multidimensional arrays. [INFO] [stdout] | |__________________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/read_write_hdf5.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! `Hdf5` functions to write ndarrays [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/read_write_hdf5.rs:9:1 [INFO] [stdout] | [INFO] [stdout] 9 | / /// Retrieve size of dimenion from an hdf5 file [INFO] [stdout] 10 | | /// [INFO] [stdout] 11 | | /// # Errors [INFO] [stdout] 12 | | /// When file or variable does not exists. [INFO] [stdout] ... | [INFO] [stdout] 15 | | /// Panics when requested dimension is not of dimensionality [INFO] [stdout] 16 | | /// 1 (i.e. not a scalar). [INFO] [stdout] | |__________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/read_write_hdf5.rs:30:1 [INFO] [stdout] | [INFO] [stdout] 30 | / /// Read scalar from hdf5 [INFO] [stdout] 31 | | /// [INFO] [stdout] 32 | | /// # Errors [INFO] [stdout] 33 | | /// When file or variable does not exists. [INFO] [stdout] ... | [INFO] [stdout] 36 | | /// Panics when requested field is not of dimensionality [INFO] [stdout] 37 | | /// 1 (i.e. not a scalar). [INFO] [stdout] | |__________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/read_write_hdf5.rs:56:1 [INFO] [stdout] | [INFO] [stdout] 56 | / /// Interface to wrtie scalar to hdf5 file [INFO] [stdout] 57 | | /// [INFO] [stdout] 58 | | /// # Errors [INFO] [stdout] 59 | | /// When file does not exist. [INFO] [stdout] | |_____________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/read_write_hdf5.rs:70:1 [INFO] [stdout] | [INFO] [stdout] 70 | / /// Read an ndarray dataset [INFO] [stdout] 71 | | /// [INFO] [stdout] 72 | | /// # Errors [INFO] [stdout] 73 | | /// File or dataset do not exist. [INFO] [stdout] 74 | | /// [INFO] [stdout] 75 | | /// # Panics [INFO] [stdout] 76 | | /// Panics when `into_dimensionality` fails. [INFO] [stdout] | |____________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/read_write_hdf5.rs:94:1 [INFO] [stdout] | [INFO] [stdout] 94 | / /// Read an ndarray dataset [INFO] [stdout] 95 | | /// [INFO] [stdout] 96 | | /// # Errors [INFO] [stdout] 97 | | /// File or dataset do not exist. [INFO] [stdout] 98 | | /// [INFO] [stdout] 99 | | /// # Panics [INFO] [stdout] 100 | | /// Panics when `into_dimensionality` fails. [INFO] [stdout] | |____________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/read_write_hdf5.rs:122:1 [INFO] [stdout] | [INFO] [stdout] 122 | / /// Write an ndarray dataset. [INFO] [stdout] 123 | | /// [INFO] [stdout] 124 | | /// Creates new file or append to existing file. [INFO] [stdout] 125 | | /// [INFO] [stdout] 126 | | /// # Errors [INFO] [stdout] 127 | | /// File does not exist or file and dataset exist, [INFO] [stdout] 128 | | /// but shapes mismatch. [INFO] [stdout] | |________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/read_write_hdf5.rs:164:1 [INFO] [stdout] | [INFO] [stdout] 164 | / /// Write an ndarray dataset. [INFO] [stdout] 165 | | /// [INFO] [stdout] 166 | | /// Creates new file or append to existing file. [INFO] [stdout] 167 | | /// [INFO] [stdout] 168 | | /// # Errors [INFO] [stdout] 169 | | /// File does not exist or file and dataset exist, [INFO] [stdout] 170 | | /// but shapes mismatch. [INFO] [stdout] | |________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/read_write_slice_hdf5.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! `Hdf5` functions to write ndarrays [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/read_write_slice_hdf5.rs:4:1 [INFO] [stdout] | [INFO] [stdout] 4 | / /// Write a slice of an ndarray dataset to an [INFO] [stdout] 5 | | /// hdf5 file. Specify the full shape of the [INFO] [stdout] 6 | | /// dataset and the slice (with ndarrays `s!` macro). [INFO] [stdout] 7 | | /// Supplied Array and slices must be smaller than `full_shape`. [INFO] [stdout] ... | [INFO] [stdout] 16 | | /// Mismatch of number of dimensions between array [INFO] [stdout] 17 | | /// and `full_shape`. [INFO] [stdout] | |_____________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/read_write_slice_hdf5.rs:64:1 [INFO] [stdout] | [INFO] [stdout] 64 | / /// Write a slice of an ndarray dataset to an [INFO] [stdout] 65 | | /// hdf5 file. Specify the full shape of the [INFO] [stdout] 66 | | /// dataset and the slice (with ndarrays `s!` macro). [INFO] [stdout] 67 | | /// Supplied Array and slices must be smaller than `full_shape`. [INFO] [stdout] ... | [INFO] [stdout] 76 | | /// Mismatch of number of dimensions between array [INFO] [stdout] 77 | | /// and `full_shape`. [INFO] [stdout] | |_____________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/read_write_slice_hdf5.rs:102:1 [INFO] [stdout] | [INFO] [stdout] 102 | / /// Read slice of an ndarray dataset [INFO] [stdout] 103 | | /// [INFO] [stdout] 104 | | /// # Errors [INFO] [stdout] 105 | | /// File or dataset do not exist. [INFO] [stdout] 106 | | /// [INFO] [stdout] 107 | | /// # Panics [INFO] [stdout] 108 | | /// Panics when `into_dimensionality` fails. [INFO] [stdout] | |____________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/read_write_slice_hdf5.rs:129:1 [INFO] [stdout] | [INFO] [stdout] 129 | / /// Read slice of an ndarray dataset [INFO] [stdout] 130 | | /// [INFO] [stdout] 131 | | /// # Errors [INFO] [stdout] 132 | | /// File or dataset do not exist. [INFO] [stdout] 133 | | /// [INFO] [stdout] 134 | | /// # Panics [INFO] [stdout] 135 | | /// Panics when `into_dimensionality` fails. [INFO] [stdout] | |____________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/traits.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! `ReadWrite` trait [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/traits.rs:9:1 [INFO] [stdout] | [INFO] [stdout] 9 | /// Read and write field (hdf5) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/traits.rs:11:5 [INFO] [stdout] | [INFO] [stdout] 11 | / /// Read field data from hdf5 file [INFO] [stdout] 12 | | /// [INFO] [stdout] 13 | | /// # Errors [INFO] [stdout] 14 | | /// Can't read file [INFO] [stdout] | |_______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/traits.rs:16:5 [INFO] [stdout] | [INFO] [stdout] 16 | /// Read field data from hdf5 file and handle result [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/traits.rs:18:5 [INFO] [stdout] | [INFO] [stdout] 18 | / /// Write field data from hdf5 file [INFO] [stdout] 19 | | /// [INFO] [stdout] 20 | | /// # Errors [INFO] [stdout] 21 | | /// Can't write file [INFO] [stdout] | |________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/io/traits.rs:23:5 [INFO] [stdout] | [INFO] [stdout] 23 | /// Write field data from hdf5 file and handle result [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/mpi/mod.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! MPI Routines [INFO] [stdout] | ^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/mpi/mod.rs:16:1 [INFO] [stdout] | [INFO] [stdout] 16 | /// Integrate trait, step forward in time, and write results [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/mpi/mod.rs:18:5 [INFO] [stdout] | [INFO] [stdout] 18 | /// Update solution [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/mpi/mod.rs:20:5 [INFO] [stdout] | [INFO] [stdout] 20 | /// Receive current time [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/mpi/mod.rs:22:5 [INFO] [stdout] | [INFO] [stdout] 22 | /// Get timestep [INFO] [stdout] | ^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/mpi/mod.rs:24:5 [INFO] [stdout] | [INFO] [stdout] 24 | /// Callback function (can be used for i/o) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/mpi/mod.rs:26:5 [INFO] [stdout] | [INFO] [stdout] 26 | /// Additional break criteria [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/mpi/mod.rs:28:5 [INFO] [stdout] | [INFO] [stdout] 28 | /// Get processor rank [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/mpi/mod.rs:32:1 [INFO] [stdout] | [INFO] [stdout] 32 | / /// Integrade pde, that implements the Integrate trait. [INFO] [stdout] 33 | | /// [INFO] [stdout] 34 | | /// Specify `save_intervall` to force writing an output. [INFO] [stdout] 35 | | /// [INFO] [stdout] 36 | | /// Stop Criteria: [INFO] [stdout] 37 | | /// 1. Timestep limit [INFO] [stdout] 38 | | /// 2. Time limit [INFO] [stdout] | |_________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/mod.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Navier--Stokes solver (no mpi) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/boundary_conditions.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Collection of Boundary conditions [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/boundary_conditions.rs:13:1 [INFO] [stdout] | [INFO] [stdout] 13 | / /// Return field for rayleigh benard [INFO] [stdout] 14 | | /// type temperature boundary conditions: [INFO] [stdout] 15 | | /// [INFO] [stdout] 16 | | /// T = 0.5 at the bottom and T = -0.5 [INFO] [stdout] 17 | | /// at the top [INFO] [stdout] | |______________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/boundary_conditions.rs:38:1 [INFO] [stdout] | [INFO] [stdout] 38 | / /// Return field for rayleigh benard [INFO] [stdout] 39 | | /// type pressure boundary conditions: [INFO] [stdout] | |______________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/boundary_conditions.rs:72:1 [INFO] [stdout] | [INFO] [stdout] 72 | / /// Return field for zero sidewall boundary [INFO] [stdout] 73 | | /// condition with smooth transfer function [INFO] [stdout] 74 | | /// to T = 0.5 at the bottom and T = -0.5 [INFO] [stdout] 75 | | /// at the top [INFO] [stdout] ... | [INFO] [stdout] 78 | | /// [INFO] [stdout] 79 | | /// * `k` - Transition parameter (larger means smoother) [INFO] [stdout] | |________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/boundary_conditions.rs:96:1 [INFO] [stdout] | [INFO] [stdout] 96 | / /// Return field for Horizontal convection [INFO] [stdout] 97 | | /// type temperature boundary conditions: [INFO] [stdout] 98 | | /// [INFO] [stdout] 99 | | /// T = sin(2*pi/L * x) at the bottom [INFO] [stdout] 100 | | /// and T = T' = 0 at the top [INFO] [stdout] | |_____________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/boundary_conditions.rs:138:1 [INFO] [stdout] | [INFO] [stdout] 138 | / /// Return field for rayleigh benard [INFO] [stdout] 139 | | /// type temperature boundary conditions: [INFO] [stdout] 140 | | /// [INFO] [stdout] 141 | | /// T = 0.5 at the bottom and T = -0.5 [INFO] [stdout] 142 | | /// at the top [INFO] [stdout] | |______________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/boundary_conditions.rs:163:1 [INFO] [stdout] | [INFO] [stdout] 163 | / /// Return field for Horizontal convection [INFO] [stdout] 164 | | /// type temperature boundary conditions: [INFO] [stdout] 165 | | /// [INFO] [stdout] 166 | | /// T = sin(2*pi/L * x) at the bottom [INFO] [stdout] 167 | | /// and T = T' = 0 at the top [INFO] [stdout] | |_____________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/boundary_conditions.rs:205:1 [INFO] [stdout] | [INFO] [stdout] 205 | / /// Return field for rayleigh benard [INFO] [stdout] 206 | | /// type pressure boundary conditions: [INFO] [stdout] | |______________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/boundary_conditions.rs:239:1 [INFO] [stdout] | [INFO] [stdout] 239 | /// Return bc field with only zeros [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/boundary_conditions.rs:250:1 [INFO] [stdout] | [INFO] [stdout] 250 | /// Return bc field with only zeros [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/boundary_conditions.rs:261:1 [INFO] [stdout] | [INFO] [stdout] 261 | /// Transfer function for zero sidewall boundary condition [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/functions.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Some useful post-processing functions [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/functions.rs:11:1 [INFO] [stdout] | [INFO] [stdout] 11 | /// Return viscosity from Ra, Pr, and height of the cell [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/functions.rs:17:1 [INFO] [stdout] | [INFO] [stdout] 17 | /// Return diffusivity from Ra, Pr, and height of the cell [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/functions.rs:23:1 [INFO] [stdout] | [INFO] [stdout] 23 | /// Return l2 norm of real array [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/functions.rs:28:1 [INFO] [stdout] | [INFO] [stdout] 28 | /// Return l2 norm of complex array [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/functions.rs:37:1 [INFO] [stdout] | [INFO] [stdout] 37 | / /// Calculate u*dvdx [INFO] [stdout] 38 | | /// [INFO] [stdout] 39 | | /// # Input [INFO] [stdout] 40 | | /// *u*: ndarray (2D) [INFO] [stdout] ... | [INFO] [stdout] 54 | | /// [INFO] [stdout] 55 | | /// Collect all convective terms, thatn transform to spectral space. [INFO] [stdout] | |____________________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/functions.rs:71:1 [INFO] [stdout] | [INFO] [stdout] 71 | /// Dealias field (2/3 rule) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/functions.rs:84:1 [INFO] [stdout] | [INFO] [stdout] 84 | /// Construct field f(x,y) = amp \* sin(pi\*m)cos(pi\*n) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/functions.rs:106:1 [INFO] [stdout] | [INFO] [stdout] 106 | /// Construct field f(x,y) = amp \* cos(pi\*m)sin(pi\*n) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/functions.rs:128:1 [INFO] [stdout] | [INFO] [stdout] 128 | /// Apply random disturbance [-c, c] [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/functions.rs:142:1 [INFO] [stdout] | [INFO] [stdout] 142 | / /// Returns Nusselt number (heat flux at the plates) [INFO] [stdout] 143 | | /// $$ [INFO] [stdout] 144 | | /// Nu = \langle - dTdz \rangle\\_x (0/H)) [INFO] [stdout] 145 | | /// $$ [INFO] [stdout] | |______^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/functions.rs:170:1 [INFO] [stdout] | [INFO] [stdout] 170 | / /// Returns volumetric Nusselt number [INFO] [stdout] 171 | | /// $$ [INFO] [stdout] 172 | | /// Nuvol = \langle vely*T/kappa - dTdz \rangle\\_V [INFO] [stdout] 173 | | /// $$ [INFO] [stdout] | |______^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/functions.rs:209:1 [INFO] [stdout] | [INFO] [stdout] 209 | / /// Returns Reynolds number base on kinetic energy [INFO] [stdout] 210 | | /// $$ [INFO] [stdout] 211 | | /// Re = U*L / nu [INFO] [stdout] 212 | | /// U = \sqrt{(velx^2 + vely^2)} [INFO] [stdout] 213 | | /// $$ [INFO] [stdout] | |______^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! # Direct numerical simulation [INFO] [stdout] 2 | | //! Solver for 2-dimensional Navier-Stokes momentum equations [INFO] [stdout] 3 | | //! coupled with temperature equation. [INFO] [stdout] 4 | | //! [INFO] [stdout] ... | [INFO] [stdout] 25 | | //! } [INFO] [stdout] 26 | | //! ``` [INFO] [stdout] | |_______^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:48:1 [INFO] [stdout] | [INFO] [stdout] 48 | /// Container for Navier Stokes simulations [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:91:1 [INFO] [stdout] | [INFO] [stdout] 91 | / impl Navier2D [INFO] [stdout] 92 | | where [INFO] [stdout] 93 | | T: Zero, [INFO] [stdout] 94 | | { [INFO] [stdout] ... | [INFO] [stdout] 99 | | } [INFO] [stdout] 100 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:102:1 [INFO] [stdout] | [INFO] [stdout] 102 | / impl Navier2D [INFO] [stdout] 103 | | where [INFO] [stdout] 104 | | S: BaseSpace, [INFO] [stdout] 105 | | T: Scalar + Mul + Div, [INFO] [stdout] ... | [INFO] [stdout] 150 | | } [INFO] [stdout] 151 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:107:5 [INFO] [stdout] | [INFO] [stdout] 107 | / /// Returns Nusselt number (heat flux at the plates) [INFO] [stdout] 108 | | /// $$ [INFO] [stdout] 109 | | /// Nu = \langle - dTdz \rangle\\_x (0/H)) [INFO] [stdout] 110 | | /// $$ [INFO] [stdout] | |__________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:116:5 [INFO] [stdout] | [INFO] [stdout] 116 | / /// Returns volumetric Nusselt number [INFO] [stdout] 117 | | /// $$ [INFO] [stdout] 118 | | /// Nuvol = \langle vely*T/kappa - dTdz \rangle\\_V [INFO] [stdout] 119 | | /// $$ [INFO] [stdout] 120 | | /// [INFO] [stdout] 121 | | /// # Panics [INFO] [stdout] 122 | | /// If *ka* is not in params [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:136:5 [INFO] [stdout] | [INFO] [stdout] 136 | / /// Returns Reynolds number based on kinetic energy [INFO] [stdout] 137 | | /// [INFO] [stdout] 138 | | /// # Panics [INFO] [stdout] 139 | | /// If *nu* is not in params [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:152:1 [INFO] [stdout] | [INFO] [stdout] 152 | / impl Navier2D [INFO] [stdout] 153 | | where [INFO] [stdout] 154 | | S: BaseSpace, [INFO] [stdout] 155 | | T: Zero, [INFO] [stdout] ... | [INFO] [stdout] 187 | | } [INFO] [stdout] 188 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:157:5 [INFO] [stdout] | [INFO] [stdout] 157 | / /// Initialize velocity with fourier modes [INFO] [stdout] 158 | | /// [INFO] [stdout] 159 | | /// velx = amp \* sin(mx)cos(nx) [INFO] [stdout] 160 | | /// vely = -amp \* cos(mx)sin(nx) [INFO] [stdout] | |_____________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:165:5 [INFO] [stdout] | [INFO] [stdout] 165 | / /// Initialize temperature with fourier modes [INFO] [stdout] 166 | | /// [INFO] [stdout] 167 | | /// temp = -amp \* cos(mx)sin(ny) [INFO] [stdout] | |_____________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:172:5 [INFO] [stdout] | [INFO] [stdout] 172 | /// Initialize all fields with random disturbances [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:184:5 [INFO] [stdout] | [INFO] [stdout] 184 | /// Reset time [INFO] [stdout] | ^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:190:1 [INFO] [stdout] | [INFO] [stdout] 190 | / impl Navier2D [INFO] [stdout] 191 | | //where [INFO] [stdout] 192 | | // S: BaseSpace, [INFO] [stdout] 193 | | { [INFO] [stdout] ... | [INFO] [stdout] 308 | | } [INFO] [stdout] 309 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:194:5 [INFO] [stdout] | [INFO] [stdout] 194 | / /// Bases: Chebyshev in x & y [INFO] [stdout] 195 | | /// [INFO] [stdout] 196 | | /// Struct must be mutable, to perform the [INFO] [stdout] 197 | | /// update step, which advances the solution [INFO] [stdout] ... | [INFO] [stdout] 212 | | /// # Panics [INFO] [stdout] 213 | | /// 'bc' type not recognized, see Arguments [INFO] [stdout] | |_______________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:311:1 [INFO] [stdout] | [INFO] [stdout] 311 | / impl Navier2D, Space2R2c> [INFO] [stdout] 312 | | //where [INFO] [stdout] 313 | | // S: BaseSpace, [INFO] [stdout] 314 | | { [INFO] [stdout] ... | [INFO] [stdout] 428 | | } [INFO] [stdout] 429 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier.rs:315:5 [INFO] [stdout] | [INFO] [stdout] 315 | / /// Bases: Fourier in x and chebyshev in y [INFO] [stdout] 316 | | /// [INFO] [stdout] 317 | | /// Struct must be mutable, to perform the [INFO] [stdout] 318 | | /// update step, which advances the solution [INFO] [stdout] ... | [INFO] [stdout] 333 | | /// # Panics [INFO] [stdout] 334 | | /// 'bc' type not recognized, see Arguments [INFO] [stdout] | |_______________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/solid_masks.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! Collection of mask functions for solid-fluid interaction [INFO] [stdout] 2 | | //! # Example [INFO] [stdout] 3 | | //! Solve 2-D Rayleigh Benard Convection with cylindrical obstacle [INFO] [stdout] 4 | | //! ```ignore [INFO] [stdout] ... | [INFO] [stdout] 28 | | //! } [INFO] [stdout] 29 | | //! ``` [INFO] [stdout] | |_______^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/solid_masks.rs:33:1 [INFO] [stdout] | [INFO] [stdout] 33 | /// Return mask for solid cylinder (everything with r < radius is solid) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/solid_masks.rs:58:1 [INFO] [stdout] | [INFO] [stdout] 58 | /// Return mask for solid rectangle [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/solid_masks.rs:79:1 [INFO] [stdout] | [INFO] [stdout] 79 | /// Return mask for sinusoidal roughness elements [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/solid_masks.rs:119:1 [INFO] [stdout] | [INFO] [stdout] 119 | /// Return multiple circles which mimik porosity [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/solid_masks.rs:157:1 [INFO] [stdout] | [INFO] [stdout] 157 | / /// Interpolates porosity from a 513 x 513 grid onto the requested size [INFO] [stdout] 158 | | /// for base chebyshev / chebyshev. [INFO] [stdout] | |___________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/statistics.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Collect Statistics [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/statistics.rs:11:1 [INFO] [stdout] | [INFO] [stdout] 11 | /// Collection of fields for statistics [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/statistics.rs:39:1 [INFO] [stdout] | [INFO] [stdout] 39 | / impl Statistics [INFO] [stdout] 40 | | where [INFO] [stdout] 41 | | S: BaseSpace, [INFO] [stdout] 42 | | T: std::ops::Add [INFO] [stdout] ... | [INFO] [stdout] 108 | | } [INFO] [stdout] 109 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/statistics.rs:48:5 [INFO] [stdout] | [INFO] [stdout] 48 | /// Allocate statistics [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/statistics.rs:78:5 [INFO] [stdout] | [INFO] [stdout] 78 | / /// Update Statistics [INFO] [stdout] 79 | | /// [INFO] [stdout] 80 | | /// # Panics [INFO] [stdout] 81 | | /// If *ka* is not in params [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/statistics.rs:111:1 [INFO] [stdout] | [INFO] [stdout] 111 | / impl Statistics [INFO] [stdout] 112 | | where [INFO] [stdout] 113 | | S: BaseSpace, [INFO] [stdout] 114 | | Field2: ReadWrite, [INFO] [stdout] ... | [INFO] [stdout] 177 | | } [INFO] [stdout] 178 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/statistics.rs:116:5 [INFO] [stdout] | [INFO] [stdout] 116 | / /// Read fields [INFO] [stdout] 117 | | /// # Errors [INFO] [stdout] 118 | | /// Failed to read [INFO] [stdout] | |______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/statistics.rs:131:5 [INFO] [stdout] | [INFO] [stdout] 131 | /// Read snapshot from file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/statistics.rs:141:5 [INFO] [stdout] | [INFO] [stdout] 141 | / /// Write snapshot to file [INFO] [stdout] 142 | | /// # Errors [INFO] [stdout] 143 | | /// Failed to write [INFO] [stdout] | |_______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/statistics.rs:161:5 [INFO] [stdout] | [INFO] [stdout] 161 | /// Write snapshot to file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! # Adjoint descent method for steady state solutions [INFO] [stdout] 2 | | //! Solve adjoint 2-dimensional Navier-Stokes equations [INFO] [stdout] 3 | | //! coupled with temperature equations to obtain steady [INFO] [stdout] 4 | | //! state solutions [INFO] [stdout] ... | [INFO] [stdout] 41 | | //! boundary conditions [INFO] [stdout] 42 | | //! J. Fluid Mech., In Print. [INFO] [stdout] | |_____________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:66:1 [INFO] [stdout] | [INFO] [stdout] 66 | /// Container for Adjoint Navier-Stokes solver [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:115:1 [INFO] [stdout] | [INFO] [stdout] 115 | / impl Navier2DAdjoint [INFO] [stdout] 116 | | where [INFO] [stdout] 117 | | T: Zero, [INFO] [stdout] 118 | | { [INFO] [stdout] ... | [INFO] [stdout] 123 | | } [INFO] [stdout] 124 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:126:1 [INFO] [stdout] | [INFO] [stdout] 126 | / impl Navier2DAdjoint [INFO] [stdout] 127 | | where [INFO] [stdout] 128 | | S: BaseSpace, [INFO] [stdout] 129 | | T: Scalar + Mul + Div, [INFO] [stdout] ... | [INFO] [stdout] 174 | | } [INFO] [stdout] 175 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:131:5 [INFO] [stdout] | [INFO] [stdout] 131 | / /// Returns Nusselt number (heat flux at the plates) [INFO] [stdout] 132 | | /// $$ [INFO] [stdout] 133 | | /// Nu = \langle - dTdz \rangle\\_x (0/H)) [INFO] [stdout] 134 | | /// $$ [INFO] [stdout] | |__________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:140:5 [INFO] [stdout] | [INFO] [stdout] 140 | / /// Returns volumetric Nusselt number [INFO] [stdout] 141 | | /// $$ [INFO] [stdout] 142 | | /// Nuvol = \langle vely*T/kappa - dTdz \rangle\\_V [INFO] [stdout] 143 | | /// $$ [INFO] [stdout] 144 | | /// [INFO] [stdout] 145 | | /// # Panics [INFO] [stdout] 146 | | /// If *ka* is not in params [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:160:5 [INFO] [stdout] | [INFO] [stdout] 160 | / /// Returns Reynolds number based on kinetic energy [INFO] [stdout] 161 | | /// [INFO] [stdout] 162 | | /// # Panics [INFO] [stdout] 163 | | /// If *nu* is not in params [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:176:1 [INFO] [stdout] | [INFO] [stdout] 176 | / impl Navier2DAdjoint [INFO] [stdout] 177 | | where [INFO] [stdout] 178 | | S: BaseSpace, [INFO] [stdout] 179 | | T: Zero, [INFO] [stdout] ... | [INFO] [stdout] 211 | | } [INFO] [stdout] 212 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:181:5 [INFO] [stdout] | [INFO] [stdout] 181 | / /// Initialize velocity with fourier modes [INFO] [stdout] 182 | | /// [INFO] [stdout] 183 | | /// velx = amp \* sin(mx)cos(nx) [INFO] [stdout] 184 | | /// vely = -amp \* cos(mx)sin(nx) [INFO] [stdout] | |_____________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:189:5 [INFO] [stdout] | [INFO] [stdout] 189 | / /// Initialize temperature with fourier modes [INFO] [stdout] 190 | | /// [INFO] [stdout] 191 | | /// temp = -amp \* cos(mx)sin(ny) [INFO] [stdout] | |_____________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:196:5 [INFO] [stdout] | [INFO] [stdout] 196 | /// Initialize all fields with random disturbances [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:208:5 [INFO] [stdout] | [INFO] [stdout] 208 | /// Reset time [INFO] [stdout] | ^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:214:1 [INFO] [stdout] | [INFO] [stdout] 214 | / impl Navier2DAdjoint { [INFO] [stdout] 215 | | /// Bases: Chebyshev in x & y [INFO] [stdout] 216 | | /// [INFO] [stdout] 217 | | /// Struct must be mutable, to perform the [INFO] [stdout] ... | [INFO] [stdout] 371 | | } [INFO] [stdout] 372 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:215:5 [INFO] [stdout] | [INFO] [stdout] 215 | / /// Bases: Chebyshev in x & y [INFO] [stdout] 216 | | /// [INFO] [stdout] 217 | | /// Struct must be mutable, to perform the [INFO] [stdout] 218 | | /// update step, which advances the solution [INFO] [stdout] ... | [INFO] [stdout] 233 | | /// # Panics [INFO] [stdout] 234 | | /// 'bc' type not recognized, see Arguments [INFO] [stdout] | |_______________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:374:1 [INFO] [stdout] | [INFO] [stdout] 374 | / impl Navier2DAdjoint, Space2R2c> { [INFO] [stdout] 375 | | /// Bases: Fourier in x and chebyshev in y [INFO] [stdout] 376 | | /// [INFO] [stdout] 377 | | /// Struct must be mutable, to perform the [INFO] [stdout] ... | [INFO] [stdout] 531 | | } [INFO] [stdout] 532 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint.rs:375:5 [INFO] [stdout] | [INFO] [stdout] 375 | / /// Bases: Fourier in x and chebyshev in y [INFO] [stdout] 376 | | /// [INFO] [stdout] 377 | | /// Struct must be mutable, to perform the [INFO] [stdout] 378 | | /// update step, which advances the solution [INFO] [stdout] ... | [INFO] [stdout] 392 | | /// # Panics [INFO] [stdout] 393 | | /// 'bc' type not recognized, see Arguments [INFO] [stdout] | |_______________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_eq.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Implement equations for `Navier2DAdjoint` [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_eq.rs:12:1 [INFO] [stdout] | [INFO] [stdout] 12 | /// General [INFO] [stdout] | ^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_eq.rs:18:5 [INFO] [stdout] | [INFO] [stdout] 18 | /// Divergence: duxdx + duydy [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_eq.rs:27:1 [INFO] [stdout] | [INFO] [stdout] 27 | /// Return L2 norm of divergence [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_eq.rs:29:5 [INFO] [stdout] | [INFO] [stdout] 29 | /// Return L2 norm of divergence [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_eq.rs:31:5 [INFO] [stdout] | [INFO] [stdout] 31 | /// Return norm of residual (velx, vely, temp) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_eq.rs:71:1 [INFO] [stdout] | [INFO] [stdout] 71 | /// Convection [INFO] [stdout] | ^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_eq.rs:122:1 [INFO] [stdout] | [INFO] [stdout] 122 | /// Solve momentum and temperature equations [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_eq.rs:184:1 [INFO] [stdout] | [INFO] [stdout] 184 | /// Pressure update [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_eq.rs:233:1 [INFO] [stdout] | [INFO] [stdout] 233 | /// Solve pressure field [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_eq.rs:252:1 [INFO] [stdout] | [INFO] [stdout] 252 | / impl Navier2DAdjoint [INFO] [stdout] 253 | | where [INFO] [stdout] 254 | | S: BaseSpace, [INFO] [stdout] 255 | | T: Scalar, [INFO] [stdout] ... | [INFO] [stdout] 341 | | } [INFO] [stdout] 342 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_eq.rs:344:1 [INFO] [stdout] | [INFO] [stdout] 344 | /// Solve momentum and temperature equations [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_io.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! Implement io routines for `Navier2DAdjoint` [INFO] [stdout] 2 | | //! Implement io routines for `Navier2D` [INFO] [stdout] | |________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_io.rs:14:1 [INFO] [stdout] | [INFO] [stdout] 14 | / impl Navier2DAdjoint [INFO] [stdout] 15 | | where [INFO] [stdout] 16 | | S: BaseSpace, [INFO] [stdout] 17 | | Field2: ReadWrite, [INFO] [stdout] ... | [INFO] [stdout] 77 | | } [INFO] [stdout] 78 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_io.rs:19:5 [INFO] [stdout] | [INFO] [stdout] 19 | / /// Read snapshot from file [INFO] [stdout] 20 | | /// # Errors [INFO] [stdout] 21 | | /// Failed to read [INFO] [stdout] | |______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_io.rs:36:5 [INFO] [stdout] | [INFO] [stdout] 36 | /// Read snapshot from file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_io.rs:46:5 [INFO] [stdout] | [INFO] [stdout] 46 | / /// Write snapshot to file [INFO] [stdout] 47 | | /// # Errors [INFO] [stdout] 48 | | /// Failed to write [INFO] [stdout] | |_______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_io.rs:71:5 [INFO] [stdout] | [INFO] [stdout] 71 | /// Write snapshot to file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_io.rs:80:1 [INFO] [stdout] | [INFO] [stdout] 80 | / impl Navier2DAdjoint [INFO] [stdout] 81 | | where [INFO] [stdout] 82 | | S: BaseSpace, [INFO] [stdout] 83 | | Field2: ReadWrite, [INFO] [stdout] ... | [INFO] [stdout] 143 | | } [INFO] [stdout] 144 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/steady_adjoint_io.rs:87:5 [INFO] [stdout] | [INFO] [stdout] 87 | / /// Define all I/O related routines for `Navier2DLnse` [INFO] [stdout] 88 | | /// [INFO] [stdout] 89 | | /// # Panics [INFO] [stdout] 90 | | /// If folder `data` or file `info_name` cannot be created [INFO] [stdout] | |______________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/vorticity.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! Calculate vorticity from a given file [INFO] [stdout] 2 | | //! [INFO] [stdout] 3 | | //! # Example [INFO] [stdout] 4 | | //! [INFO] [stdout] ... | [INFO] [stdout] 22 | | //! } [INFO] [stdout] 23 | | //! ``` [INFO] [stdout] | |_______^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/vorticity.rs:35:1 [INFO] [stdout] | [INFO] [stdout] 35 | / /// Read velocities from file, [INFO] [stdout] 36 | | /// calculate dudy - dvdx and append vortictiy [INFO] [stdout] 37 | | /// [INFO] [stdout] 38 | | /// # Errors [INFO] [stdout] 39 | | /// Can't read file [INFO] [stdout] | |___________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/vorticity.rs:58:1 [INFO] [stdout] | [INFO] [stdout] 58 | / /// Read velocities from file, [INFO] [stdout] 59 | | /// calculate dudy - dvdx and append vortictiy [INFO] [stdout] 60 | | /// [INFO] [stdout] 61 | | /// x-direction is periodic [INFO] [stdout] 62 | | /// [INFO] [stdout] 63 | | /// # Errors [INFO] [stdout] 64 | | /// Can't read file [INFO] [stdout] | |___________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_eq.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Implement equations for navier-stokes simulations [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_eq.rs:12:1 [INFO] [stdout] | [INFO] [stdout] 12 | /// General [INFO] [stdout] | ^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_eq.rs:18:5 [INFO] [stdout] | [INFO] [stdout] 18 | /// Divergence: duxdx + duydy [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_eq.rs:27:1 [INFO] [stdout] | [INFO] [stdout] 27 | /// Return L2 norm of divergence [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_eq.rs:29:5 [INFO] [stdout] | [INFO] [stdout] 29 | /// Return L2 norm of divergence [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_eq.rs:53:1 [INFO] [stdout] | [INFO] [stdout] 53 | /// Convection [INFO] [stdout] | ^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_eq.rs:104:1 [INFO] [stdout] | [INFO] [stdout] 104 | /// Pressure update [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_eq.rs:128:1 [INFO] [stdout] | [INFO] [stdout] 128 | / impl Navier2D [INFO] [stdout] 129 | | where [INFO] [stdout] 130 | | S: BaseSpace, [INFO] [stdout] 131 | | T: Scalar + From + ScalarOperand + Mul, [INFO] [stdout] ... | [INFO] [stdout] 143 | | } [INFO] [stdout] 144 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_eq.rs:146:1 [INFO] [stdout] | [INFO] [stdout] 146 | /// Solve pressure field [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_eq.rs:165:1 [INFO] [stdout] | [INFO] [stdout] 165 | /// Solve momentum and temperature equations [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_io.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Implement io routines for `Navier2D` [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_io.rs:13:1 [INFO] [stdout] | [INFO] [stdout] 13 | / impl Navier2D [INFO] [stdout] 14 | | where [INFO] [stdout] 15 | | S: BaseSpace, [INFO] [stdout] 16 | | Field2: ReadWrite, [INFO] [stdout] ... | [INFO] [stdout] 70 | | } [INFO] [stdout] 71 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_io.rs:18:5 [INFO] [stdout] | [INFO] [stdout] 18 | / /// Read snapshot from file [INFO] [stdout] 19 | | /// # Errors [INFO] [stdout] 20 | | /// Failed to read [INFO] [stdout] | |______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_io.rs:31:5 [INFO] [stdout] | [INFO] [stdout] 31 | /// Read snapshot from file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_io.rs:41:5 [INFO] [stdout] | [INFO] [stdout] 41 | / /// Write snapshot to file [INFO] [stdout] 42 | | /// # Errors [INFO] [stdout] 43 | | /// Failed to write [INFO] [stdout] | |_______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_io.rs:64:5 [INFO] [stdout] | [INFO] [stdout] 64 | /// Write snapshot to file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_io.rs:73:1 [INFO] [stdout] | [INFO] [stdout] 73 | / impl Navier2D [INFO] [stdout] 74 | | where [INFO] [stdout] 75 | | S: BaseSpace, [INFO] [stdout] 76 | | Field2: ReadWrite, [INFO] [stdout] ... | [INFO] [stdout] 149 | | } [INFO] [stdout] 150 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes/navier_io.rs:80:5 [INFO] [stdout] | [INFO] [stdout] 80 | / /// Define all I/O related routines for `Navier2DLnse` [INFO] [stdout] 81 | | /// [INFO] [stdout] 82 | | /// # Panics [INFO] [stdout] 83 | | /// If folder `data` or file `info_name` cannot be created [INFO] [stdout] | |______________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/mod.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Linearized Navier-Stokes equations [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/functions.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Functions for `Navier2DLnse` [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/functions.rs:10:1 [INFO] [stdout] | [INFO] [stdout] 10 | /// b1 * ux**2 + b1 * uy**2 + b2 * temp**2 [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/functions.rs:29:1 [INFO] [stdout] | [INFO] [stdout] 29 | /// Norm with three scalar products [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/functions.rs:59:1 [INFO] [stdout] | [INFO] [stdout] 59 | / /// Returns Nusselt number (heat flux at the plates) [INFO] [stdout] 60 | | /// $$ [INFO] [stdout] 61 | | /// Nu = \langle - dTdz \rangle\\_x (0/H)) [INFO] [stdout] 62 | | /// $$ [INFO] [stdout] | |______^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/functions.rs:83:1 [INFO] [stdout] | [INFO] [stdout] 83 | / /// Returns volumetric Nusselt number [INFO] [stdout] 84 | | /// $$ [INFO] [stdout] 85 | | /// Nuvol = \langle vely*T/kappa - dTdz \rangle\\_V [INFO] [stdout] 86 | | /// $$ [INFO] [stdout] | |______^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/functions.rs:120:1 [INFO] [stdout] | [INFO] [stdout] 120 | / /// Returns Reynolds number base on kinetic energy [INFO] [stdout] 121 | | /// $$ [INFO] [stdout] 122 | | /// Re = U*L / nu [INFO] [stdout] 123 | | /// U = \sqrt{(velx^2 + vely^2)} [INFO] [stdout] 124 | | /// $$ [INFO] [stdout] | |______^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Linearized Navier--Stokes equations [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse.rs:23:1 [INFO] [stdout] | [INFO] [stdout] 23 | /// Linearized Navier Stokes solver [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse.rs:57:1 [INFO] [stdout] | [INFO] [stdout] 57 | / impl Navier2DLnse [INFO] [stdout] 58 | | where [INFO] [stdout] 59 | | T: num_traits::Zero, [INFO] [stdout] 60 | | { [INFO] [stdout] ... | [INFO] [stdout] 65 | | } [INFO] [stdout] 66 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse.rs:68:1 [INFO] [stdout] | [INFO] [stdout] 68 | / impl Navier2DLnse [INFO] [stdout] 69 | | where [INFO] [stdout] 70 | | T: num_traits::Zero, [INFO] [stdout] 71 | | S: BaseSpace, [INFO] [stdout] ... | [INFO] [stdout] 79 | | } [INFO] [stdout] 80 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse.rs:73:5 [INFO] [stdout] | [INFO] [stdout] 73 | /// Set random initial fields: -amp < x < amp [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse.rs:82:1 [INFO] [stdout] | [INFO] [stdout] 82 | / impl Navier2DLnse { [INFO] [stdout] 83 | | /// Linearized Navier Stokes solver with sidewalls [INFO] [stdout] 84 | | /// # Panics [INFO] [stdout] 85 | | /// 'bc' type not recognized [INFO] [stdout] ... | [INFO] [stdout] 166 | | } [INFO] [stdout] 167 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse.rs:83:5 [INFO] [stdout] | [INFO] [stdout] 83 | / /// Linearized Navier Stokes solver with sidewalls [INFO] [stdout] 84 | | /// # Panics [INFO] [stdout] 85 | | /// 'bc' type not recognized [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse.rs:169:1 [INFO] [stdout] | [INFO] [stdout] 169 | / impl Navier2DLnse, Space2R2c> { [INFO] [stdout] 170 | | /// Linearized Navier Stokes solver with periodic sidewalls [INFO] [stdout] 171 | | /// # Panics [INFO] [stdout] 172 | | /// 'bc' type not recognized [INFO] [stdout] ... | [INFO] [stdout] 253 | | } [INFO] [stdout] 254 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse.rs:170:5 [INFO] [stdout] | [INFO] [stdout] 170 | / /// Linearized Navier Stokes solver with periodic sidewalls [INFO] [stdout] 171 | | /// # Panics [INFO] [stdout] 172 | | /// 'bc' type not recognized [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_adj_eq.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Implement adjoint stability equations for `Navier2DLnse` [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_adj_eq.rs:11:1 [INFO] [stdout] | [INFO] [stdout] 11 | / impl Navier2DLnse [INFO] [stdout] 12 | | where [INFO] [stdout] 13 | | S: BaseSpace, [INFO] [stdout] 14 | | T: Scalar, [INFO] [stdout] ... | [INFO] [stdout] 90 | | } [INFO] [stdout] 91 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_adj_eq.rs:207:1 [INFO] [stdout] | [INFO] [stdout] 207 | /// Solve momentum and temperature equations [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_adj_grad.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! Calculate adjoint based sensitivity (gradient of [INFO] [stdout] 2 | | //! final energy with respect to initial field) [INFO] [stdout] | |_______________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_adj_grad.rs:18:1 [INFO] [stdout] | [INFO] [stdout] 18 | / impl Navier2DLnse [INFO] [stdout] 19 | | where [INFO] [stdout] 20 | | T: Scalar + Mul + From + ScalarOperand, [INFO] [stdout] 21 | | S: BaseSpace, [INFO] [stdout] ... | [INFO] [stdout] 226 | | } [INFO] [stdout] 227 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_adj_grad.rs:27:5 [INFO] [stdout] | [INFO] [stdout] 27 | /// Return time [INFO] [stdout] | ^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_adj_grad.rs:32:5 [INFO] [stdout] | [INFO] [stdout] 32 | /// Return timestep [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_adj_grad.rs:37:5 [INFO] [stdout] | [INFO] [stdout] 37 | /// Reset time [INFO] [stdout] | ^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_adj_grad.rs:42:5 [INFO] [stdout] | [INFO] [stdout] 42 | /// Update forward loop [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_adj_grad.rs:70:5 [INFO] [stdout] | [INFO] [stdout] 70 | /// Update adjoint loop [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_adj_grad.rs:100:5 [INFO] [stdout] | [INFO] [stdout] 100 | / /// Calculate gradient from forward and backward loop [INFO] [stdout] 101 | | /// [INFO] [stdout] 102 | | /// # Return [INFO] [stdout] 103 | | /// (funval, gradient) [INFO] [stdout] | |__________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_eq.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Implement equations for `Navier2DLnse` [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_eq.rs:12:1 [INFO] [stdout] | [INFO] [stdout] 12 | /// General [INFO] [stdout] | ^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_eq.rs:27:1 [INFO] [stdout] | [INFO] [stdout] 27 | /// Return L2 norm of divergence [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_eq.rs:29:5 [INFO] [stdout] | [INFO] [stdout] 29 | /// Return L2 norm of divergence [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_eq.rs:53:1 [INFO] [stdout] | [INFO] [stdout] 53 | / impl Navier2DLnse [INFO] [stdout] 54 | | where [INFO] [stdout] 55 | | S: BaseSpace, [INFO] [stdout] 56 | | T: Scalar, [INFO] [stdout] ... | [INFO] [stdout] 110 | | } [INFO] [stdout] 111 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_eq.rs:113:1 [INFO] [stdout] | [INFO] [stdout] 113 | /// Pressure update [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_eq.rs:149:1 [INFO] [stdout] | [INFO] [stdout] 149 | /// Solve pressure field [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_eq.rs:168:1 [INFO] [stdout] | [INFO] [stdout] 168 | /// Solve momentum and temperature equations [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_fd_grad.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! Calculate gradient of final energy with respect to initial field [INFO] [stdout] 2 | | //! using finite differences, i.e. perturb every grid point subsequently. [INFO] [stdout] 3 | | //! This is much more expensive, than adjoint based gradient computation [INFO] [stdout] 4 | | //! and should only be used for testing. [INFO] [stdout] 5 | | //! [INFO] [stdout] 6 | | //! See `examples/navier_lnse_test_gradient.rs` [INFO] [stdout] | |_______________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_fd_grad.rs:19:1 [INFO] [stdout] | [INFO] [stdout] 19 | / impl Navier2DLnse [INFO] [stdout] 20 | | where [INFO] [stdout] 21 | | T: Scalar + Mul + From + ScalarOperand, [INFO] [stdout] 22 | | S: BaseSpace, [INFO] [stdout] ... | [INFO] [stdout] 157 | | } [INFO] [stdout] 158 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_fd_grad.rs:28:5 [INFO] [stdout] | [INFO] [stdout] 28 | / /// Calculate gradient from forward and backward loop [INFO] [stdout] 29 | | /// [INFO] [stdout] 30 | | /// # Return [INFO] [stdout] 31 | | /// gradient [INFO] [stdout] | |________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_io.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Implement io routines for `Navier2DLnse` [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_io.rs:11:1 [INFO] [stdout] | [INFO] [stdout] 11 | / impl Navier2DLnse [INFO] [stdout] 12 | | where [INFO] [stdout] 13 | | S: BaseSpace, [INFO] [stdout] 14 | | Field2: ReadWrite, [INFO] [stdout] ... | [INFO] [stdout] 65 | | } [INFO] [stdout] 66 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_io.rs:16:5 [INFO] [stdout] | [INFO] [stdout] 16 | / /// Read snapshot from file [INFO] [stdout] 17 | | /// # Errors [INFO] [stdout] 18 | | /// Failed to read [INFO] [stdout] | |______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_io.rs:29:5 [INFO] [stdout] | [INFO] [stdout] 29 | /// Read snapshot from file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_io.rs:39:5 [INFO] [stdout] | [INFO] [stdout] 39 | / /// Write snapshot to file [INFO] [stdout] 40 | | /// # Errors [INFO] [stdout] 41 | | /// Failed to write [INFO] [stdout] | |_______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_io.rs:59:5 [INFO] [stdout] | [INFO] [stdout] 59 | /// Write snapshot to file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_io.rs:68:1 [INFO] [stdout] | [INFO] [stdout] 68 | / impl Navier2DLnse [INFO] [stdout] 69 | | where [INFO] [stdout] 70 | | S: BaseSpace, [INFO] [stdout] 71 | | T: Scalar, [INFO] [stdout] ... | [INFO] [stdout] 126 | | } [INFO] [stdout] 127 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/lnse_io.rs:74:5 [INFO] [stdout] | [INFO] [stdout] 74 | / /// Define all I/O related routines for `Navier2DLnse` [INFO] [stdout] 75 | | /// [INFO] [stdout] 76 | | /// # Panics [INFO] [stdout] 77 | | /// If folder `data` or file `info_name` cannot be created [INFO] [stdout] | |______________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/meanfield.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Storage for mean field [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/meanfield.rs:15:1 [INFO] [stdout] | [INFO] [stdout] 15 | /// `MeanFields` used for the linearized Navier-Stokes solver [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/meanfield.rs:26:1 [INFO] [stdout] | [INFO] [stdout] 26 | / impl MeanFields { [INFO] [stdout] 27 | | /// Return `MeanFields` for confined Rayleigh-Benard convection [INFO] [stdout] 28 | | pub fn new_rbc_confined(nx: usize, ny: usize) -> MeanFields { [INFO] [stdout] 29 | | // Allocate [INFO] [stdout] ... | [INFO] [stdout] 123 | | } [INFO] [stdout] 124 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/meanfield.rs:27:5 [INFO] [stdout] | [INFO] [stdout] 27 | /// Return `MeanFields` for confined Rayleigh-Benard convection [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/meanfield.rs:47:5 [INFO] [stdout] | [INFO] [stdout] 47 | / /// Return field for Horizontal convection [INFO] [stdout] 48 | | /// type temperature boundary conditions: [INFO] [stdout] 49 | | /// [INFO] [stdout] 50 | | /// T = sin(2*pi/L * x) at the bottom [INFO] [stdout] 51 | | /// and T = T' = 0 at the top [INFO] [stdout] | |_________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/meanfield.rs:89:5 [INFO] [stdout] | [INFO] [stdout] 89 | / /// Read meanfield from file [INFO] [stdout] 90 | | /// # Panics [INFO] [stdout] 91 | | /// 'bc' type not recognized [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/meanfield.rs:126:1 [INFO] [stdout] | [INFO] [stdout] 126 | / impl MeanFields, Space2R2c> { [INFO] [stdout] 127 | | /// Return `MeanFields` for periodic Rayleigh-Benard convection [INFO] [stdout] 128 | | /// # Panics [INFO] [stdout] 129 | | /// 'bc' type not recognized [INFO] [stdout] ... | [INFO] [stdout] 226 | | } [INFO] [stdout] 227 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/meanfield.rs:127:5 [INFO] [stdout] | [INFO] [stdout] 127 | / /// Return `MeanFields` for periodic Rayleigh-Benard convection [INFO] [stdout] 128 | | /// # Panics [INFO] [stdout] 129 | | /// 'bc' type not recognized [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/meanfield.rs:149:5 [INFO] [stdout] | [INFO] [stdout] 149 | / /// Return field for Horizontal convection [INFO] [stdout] 150 | | /// type temperature boundary conditions: [INFO] [stdout] 151 | | /// [INFO] [stdout] 152 | | /// T = sin(2*pi/L * x) at the bottom [INFO] [stdout] 153 | | /// and T = T' = 0 at the top [INFO] [stdout] | |_________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/meanfield.rs:191:5 [INFO] [stdout] | [INFO] [stdout] 191 | / /// Read meanfield from file [INFO] [stdout] 192 | | /// # Panics [INFO] [stdout] 193 | | /// If file does not exists and 'bc' type not recognized [INFO] [stdout] | |____________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/meanfield.rs:229:1 [INFO] [stdout] | [INFO] [stdout] 229 | / impl MeanFields [INFO] [stdout] 230 | | where [INFO] [stdout] 231 | | S: BaseSpace, [INFO] [stdout] 232 | | Field2: ReadWrite, [INFO] [stdout] ... | [INFO] [stdout] 289 | | } [INFO] [stdout] 290 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/meanfield.rs:234:5 [INFO] [stdout] | [INFO] [stdout] 234 | / /// Read snapshot from file [INFO] [stdout] 235 | | /// # Errors [INFO] [stdout] 236 | | /// Failed to read [INFO] [stdout] | |______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/meanfield.rs:260:5 [INFO] [stdout] | [INFO] [stdout] 260 | /// Read snapshot from file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/meanfield.rs:270:5 [INFO] [stdout] | [INFO] [stdout] 270 | / /// Write snapshot to file [INFO] [stdout] 271 | | /// # Errors [INFO] [stdout] 272 | | /// Failed to write [INFO] [stdout] | |_______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/meanfield.rs:283:5 [INFO] [stdout] | [INFO] [stdout] 283 | /// Write snapshot to file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Non-linear Navier-Stokes solver for adjoint optimizations [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin.rs:22:1 [INFO] [stdout] | [INFO] [stdout] 22 | /// Linearized Navier Stokes solver [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin.rs:59:1 [INFO] [stdout] | [INFO] [stdout] 59 | / impl Navier2DNonLin [INFO] [stdout] 60 | | where [INFO] [stdout] 61 | | T: num_traits::Zero, [INFO] [stdout] 62 | | { [INFO] [stdout] ... | [INFO] [stdout] 67 | | } [INFO] [stdout] 68 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin.rs:70:1 [INFO] [stdout] | [INFO] [stdout] 70 | / impl Navier2DNonLin [INFO] [stdout] 71 | | where [INFO] [stdout] 72 | | T: num_traits::Zero, [INFO] [stdout] 73 | | S: BaseSpace, [INFO] [stdout] ... | [INFO] [stdout] 81 | | } [INFO] [stdout] 82 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin.rs:75:5 [INFO] [stdout] | [INFO] [stdout] 75 | /// Set random initial fields: -amp < x < amp [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin.rs:84:1 [INFO] [stdout] | [INFO] [stdout] 84 | / impl Navier2DNonLin { [INFO] [stdout] 85 | | /// Linearized Navier Stokes solver with sidewalls [INFO] [stdout] 86 | | /// # Panics [INFO] [stdout] 87 | | /// 'bc' type not recognized [INFO] [stdout] ... | [INFO] [stdout] 172 | | } [INFO] [stdout] 173 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin.rs:85:5 [INFO] [stdout] | [INFO] [stdout] 85 | / /// Linearized Navier Stokes solver with sidewalls [INFO] [stdout] 86 | | /// # Panics [INFO] [stdout] 87 | | /// 'bc' type not recognized [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin.rs:175:1 [INFO] [stdout] | [INFO] [stdout] 175 | / impl Navier2DNonLin, Space2R2c> { [INFO] [stdout] 176 | | /// Linearized Navier Stokes solver with periodic sidewalls [INFO] [stdout] 177 | | /// # Panics [INFO] [stdout] 178 | | /// 'bc' type not recognized [INFO] [stdout] ... | [INFO] [stdout] 263 | | } [INFO] [stdout] 264 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin.rs:176:5 [INFO] [stdout] | [INFO] [stdout] 176 | / /// Linearized Navier Stokes solver with periodic sidewalls [INFO] [stdout] 177 | | /// # Panics [INFO] [stdout] 178 | | /// 'bc' type not recognized [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_adj_eq.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! Calculate adjoint based sensitivity (gradient of [INFO] [stdout] 2 | | //! final energy with respect to initial field) [INFO] [stdout] 3 | | //! for non-linear Navier Stokes simulations [INFO] [stdout] | |____________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_adj_eq.rs:14:1 [INFO] [stdout] | [INFO] [stdout] 14 | / impl Navier2DNonLin [INFO] [stdout] 15 | | where [INFO] [stdout] 16 | | S: BaseSpace, [INFO] [stdout] 17 | | T: Scalar, [INFO] [stdout] ... | [INFO] [stdout] 125 | | } [INFO] [stdout] 126 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_adj_eq.rs:128:1 [INFO] [stdout] | [INFO] [stdout] 128 | /// Solve momentum and temperature equations [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_adj_grad.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! Calculate adjoint based sensitivity (gradient of [INFO] [stdout] 2 | | //! final energy with respect to initial field) [INFO] [stdout] | |_______________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_adj_grad.rs:18:1 [INFO] [stdout] | [INFO] [stdout] 18 | / impl Navier2DNonLin [INFO] [stdout] 19 | | where [INFO] [stdout] 20 | | T: Scalar + Mul + From + ScalarOperand + Div, [INFO] [stdout] 21 | | S: BaseSpace, [INFO] [stdout] ... | [INFO] [stdout] 244 | | } [INFO] [stdout] 245 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_adj_grad.rs:27:5 [INFO] [stdout] | [INFO] [stdout] 27 | /// Return time [INFO] [stdout] | ^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_adj_grad.rs:32:5 [INFO] [stdout] | [INFO] [stdout] 32 | /// Return timestep [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_adj_grad.rs:37:5 [INFO] [stdout] | [INFO] [stdout] 37 | /// Reset time [INFO] [stdout] | ^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_adj_grad.rs:42:5 [INFO] [stdout] | [INFO] [stdout] 42 | /// Update forward loop [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_adj_grad.rs:81:5 [INFO] [stdout] | [INFO] [stdout] 81 | /// Update adjoint loop [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_adj_grad.rs:115:5 [INFO] [stdout] | [INFO] [stdout] 115 | / /// Calculate gradient from forward and backward loop [INFO] [stdout] 116 | | /// [INFO] [stdout] 117 | | /// # Return [INFO] [stdout] 118 | | /// (funval, gradient) [INFO] [stdout] | |__________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_eq.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Implement equations for `Navier2DNonLin` [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_eq.rs:12:1 [INFO] [stdout] | [INFO] [stdout] 12 | /// General [INFO] [stdout] | ^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_eq.rs:27:1 [INFO] [stdout] | [INFO] [stdout] 27 | /// Return L2 norm of divergence [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_eq.rs:29:5 [INFO] [stdout] | [INFO] [stdout] 29 | /// Return L2 norm of divergence [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_eq.rs:53:1 [INFO] [stdout] | [INFO] [stdout] 53 | / impl Navier2DNonLin [INFO] [stdout] 54 | | where [INFO] [stdout] 55 | | S: BaseSpace, [INFO] [stdout] 56 | | T: Scalar, [INFO] [stdout] ... | [INFO] [stdout] 131 | | } [INFO] [stdout] 132 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_eq.rs:134:1 [INFO] [stdout] | [INFO] [stdout] 134 | /// Pressure update [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_eq.rs:170:1 [INFO] [stdout] | [INFO] [stdout] 170 | /// Solve pressure field [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_eq.rs:189:1 [INFO] [stdout] | [INFO] [stdout] 189 | /// Solve momentum and temperature equations [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_io.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Implement io routines for `Navier2DLnse` [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_io.rs:13:1 [INFO] [stdout] | [INFO] [stdout] 13 | / impl Navier2DNonLin [INFO] [stdout] 14 | | where [INFO] [stdout] 15 | | S: BaseSpace, [INFO] [stdout] 16 | | Field2: ReadWrite, [INFO] [stdout] ... | [INFO] [stdout] 70 | | } [INFO] [stdout] 71 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_io.rs:18:5 [INFO] [stdout] | [INFO] [stdout] 18 | / /// Read snapshot from file [INFO] [stdout] 19 | | /// # Errors [INFO] [stdout] 20 | | /// Failed to read [INFO] [stdout] | |______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_io.rs:31:5 [INFO] [stdout] | [INFO] [stdout] 31 | /// Read snapshot from file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_io.rs:41:5 [INFO] [stdout] | [INFO] [stdout] 41 | / /// Write snapshot to file [INFO] [stdout] 42 | | /// # Errors [INFO] [stdout] 43 | | /// Failed to write [INFO] [stdout] | |_______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_io.rs:64:5 [INFO] [stdout] | [INFO] [stdout] 64 | /// Write snapshot to file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_io.rs:73:1 [INFO] [stdout] | [INFO] [stdout] 73 | / impl Navier2DNonLin [INFO] [stdout] 74 | | where [INFO] [stdout] 75 | | S: BaseSpace, [INFO] [stdout] 76 | | T: Scalar + Mul + Div, [INFO] [stdout] ... | [INFO] [stdout] 144 | | } [INFO] [stdout] 145 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_io.rs:80:5 [INFO] [stdout] | [INFO] [stdout] 80 | / /// Define all I/O related routines for `Navier2DLnse` [INFO] [stdout] 81 | | /// [INFO] [stdout] 82 | | /// # Panics [INFO] [stdout] 83 | | /// If folder `data` or file `info_name` cannot be created [INFO] [stdout] | |______________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_io.rs:147:1 [INFO] [stdout] | [INFO] [stdout] 147 | / impl Navier2DNonLin [INFO] [stdout] 148 | | where [INFO] [stdout] 149 | | S: BaseSpace, [INFO] [stdout] 150 | | T: Scalar + Mul + Div, [INFO] [stdout] ... | [INFO] [stdout] 198 | | } [INFO] [stdout] 199 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_io.rs:152:5 [INFO] [stdout] | [INFO] [stdout] 152 | / /// Returns Nusselt number (heat flux at the plates) [INFO] [stdout] 153 | | /// $$ [INFO] [stdout] 154 | | /// Nu = \langle - dTdz \rangle\\_x (0/H)) [INFO] [stdout] 155 | | /// $$ [INFO] [stdout] | |__________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_io.rs:165:5 [INFO] [stdout] | [INFO] [stdout] 165 | / /// Returns volumetric Nusselt number [INFO] [stdout] 166 | | /// $$ [INFO] [stdout] 167 | | /// Nuvol = \langle vely*T/kappa - dTdz \rangle\\_V [INFO] [stdout] 168 | | /// $$ [INFO] [stdout] 169 | | /// [INFO] [stdout] 170 | | /// # Panics [INFO] [stdout] 171 | | /// If *ka* is not in params [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/nonlin_io.rs:184:5 [INFO] [stdout] | [INFO] [stdout] 184 | / /// Returns Reynolds number based on kinetic energy [INFO] [stdout] 185 | | /// [INFO] [stdout] 186 | | /// # Panics [INFO] [stdout] 187 | | /// If *nu* is not in params [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/opt_routines.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Gradient based optimization routines [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_lnse/opt_routines.rs:5:1 [INFO] [stdout] | [INFO] [stdout] 5 | / /// Steepest descent optimization without energy increase of the [INFO] [stdout] 6 | | /// target flow (energy constrainted) [INFO] [stdout] 7 | | /// [INFO] [stdout] 8 | | /// # Panics [INFO] [stdout] 9 | | /// Input `alpha` > 2. [INFO] [stdout] | |______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/mod.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Navier--Stokes solver (mpi) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/boundary_conditions.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Collection of Boundary conditions [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/boundary_conditions.rs:12:1 [INFO] [stdout] | [INFO] [stdout] 12 | / /// Return field for rayleigh benard [INFO] [stdout] 13 | | /// type temperature boundary conditions: [INFO] [stdout] 14 | | /// [INFO] [stdout] 15 | | /// T = 0.5 at the bottom and T = -0.5 [INFO] [stdout] 16 | | /// at the top [INFO] [stdout] | |______________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/boundary_conditions.rs:109:1 [INFO] [stdout] | [INFO] [stdout] 109 | / /// Return field for Horizontal convection [INFO] [stdout] 110 | | /// type temperature boundary conditions: [INFO] [stdout] 111 | | /// [INFO] [stdout] 112 | | /// T = sin(2*pi/L * x) at the bottom [INFO] [stdout] 113 | | /// and T = T' = 0 at the top [INFO] [stdout] | |_____________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/boundary_conditions.rs:154:1 [INFO] [stdout] | [INFO] [stdout] 154 | / /// Return field for rayleigh benard [INFO] [stdout] 155 | | /// type temperature boundary conditions: [INFO] [stdout] 156 | | /// [INFO] [stdout] 157 | | /// T = 0.5 at the bottom and T = -0.5 [INFO] [stdout] 158 | | /// at the top [INFO] [stdout] | |______________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/boundary_conditions.rs:185:1 [INFO] [stdout] | [INFO] [stdout] 185 | / /// Return field for Horizontal convection [INFO] [stdout] 186 | | /// type temperature boundary conditions: [INFO] [stdout] 187 | | /// [INFO] [stdout] 188 | | /// T = sin(2*pi/L * x) at the bottom [INFO] [stdout] 189 | | /// and T = T' = 0 at the top [INFO] [stdout] | |_____________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/boundary_conditions.rs:276:1 [INFO] [stdout] | [INFO] [stdout] 276 | /// Transfer function for zero sidewall boundary condition [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/functions.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Some functions [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/functions.rs:13:1 [INFO] [stdout] | [INFO] [stdout] 13 | /// Return viscosity from Ra, Pr, and height of the cell [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/functions.rs:19:1 [INFO] [stdout] | [INFO] [stdout] 19 | /// Return diffusivity from Ra, Pr, and height of the cell [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/functions.rs:25:1 [INFO] [stdout] | [INFO] [stdout] 25 | /// Return l2 norm of real array [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/functions.rs:30:1 [INFO] [stdout] | [INFO] [stdout] 30 | /// Return l2 norm of complex array [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/functions.rs:39:1 [INFO] [stdout] | [INFO] [stdout] 39 | / /// Calculate u*dvdx [INFO] [stdout] 40 | | /// [INFO] [stdout] 41 | | /// # Input [INFO] [stdout] 42 | | /// *u*: ndarray (2D) [INFO] [stdout] ... | [INFO] [stdout] 56 | | /// [INFO] [stdout] 57 | | /// Collect all convective terms, thatn transform to spectral space. [INFO] [stdout] | |____________________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/functions.rs:74:1 [INFO] [stdout] | [INFO] [stdout] 74 | /// Dealias field (2/3 rule) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/functions.rs:99:1 [INFO] [stdout] | [INFO] [stdout] 99 | / /// Returns Nusselt number (heat flux at the plates) [INFO] [stdout] 100 | | /// $$ [INFO] [stdout] 101 | | /// Nu = \langle - dTdz \rangle\\_x (0/H)) [INFO] [stdout] 102 | | /// $$ [INFO] [stdout] | |______^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/functions.rs:142:1 [INFO] [stdout] | [INFO] [stdout] 142 | / /// Returns volumetric Nusselt number [INFO] [stdout] 143 | | /// $$ [INFO] [stdout] 144 | | /// Nuvol = \langle uy*T/kappa - dTdz \rangle\\_V [INFO] [stdout] 145 | | /// $$ [INFO] [stdout] | |______^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/functions.rs:181:1 [INFO] [stdout] | [INFO] [stdout] 181 | / /// Returns Reynolds number base on kinetic energy [INFO] [stdout] 182 | | /// $$ [INFO] [stdout] 183 | | /// Re = U*L / nu [INFO] [stdout] 184 | | /// U = \sqrt{(ux^2 + uy^2)} [INFO] [stdout] 185 | | /// $$ [INFO] [stdout] | |______^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/functions.rs:209:1 [INFO] [stdout] | [INFO] [stdout] 209 | /// Construct field f(x,y) = amp \* sin(pi\*m)cos(pi\*n) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/functions.rs:231:1 [INFO] [stdout] | [INFO] [stdout] 231 | /// Construct field f(x,y) = amp \* cos(pi\*m)sin(pi\*n) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/functions.rs:268:1 [INFO] [stdout] | [INFO] [stdout] 268 | /// Apply random disturbances [-c, c] [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! # Solver for Boussinesq equations (mpi supported) [INFO] [stdout] 2 | | //! Default: Rayleigh Benard Convection [INFO] [stdout] | |_______________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:25:1 [INFO] [stdout] | [INFO] [stdout] 25 | / /// Solve 2-dimensional Navier-Stokes equations [INFO] [stdout] 26 | | /// coupled with temperature equations [INFO] [stdout] | |______________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:74:1 [INFO] [stdout] | [INFO] [stdout] 74 | / impl Navier2DMpi<'_, T, S> { [INFO] [stdout] 75 | | /// Return current rank [INFO] [stdout] 76 | | #[allow(clippy::cast_sign_loss)] [INFO] [stdout] 77 | | pub fn nrank(&self) -> usize { [INFO] [stdout] ... | [INFO] [stdout] 92 | | } [INFO] [stdout] 93 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:75:5 [INFO] [stdout] | [INFO] [stdout] 75 | /// Return current rank [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:82:5 [INFO] [stdout] | [INFO] [stdout] 82 | /// Return total number of processors [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:89:5 [INFO] [stdout] | [INFO] [stdout] 89 | /// Reset time [INFO] [stdout] | ^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:95:1 [INFO] [stdout] | [INFO] [stdout] 95 | / impl Navier2DMpi<'_, T, S> [INFO] [stdout] 96 | | where [INFO] [stdout] 97 | | T: Zero, [INFO] [stdout] 98 | | { [INFO] [stdout] ... | [INFO] [stdout] 103 | | } [INFO] [stdout] 104 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:106:1 [INFO] [stdout] | [INFO] [stdout] 106 | / impl Navier2DMpi<'_, T, S> [INFO] [stdout] 107 | | where [INFO] [stdout] 108 | | S: BaseSpace + BaseSpaceMpi, [INFO] [stdout] 109 | | T: Scalar + Mul + Div, [INFO] [stdout] ... | [INFO] [stdout] 154 | | } [INFO] [stdout] 155 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:111:5 [INFO] [stdout] | [INFO] [stdout] 111 | / /// Returns Nusselt number (heat flux at the plates) [INFO] [stdout] 112 | | /// $$ [INFO] [stdout] 113 | | /// Nu = \langle - dTdz \rangle\\_x (0/H)) [INFO] [stdout] 114 | | /// $$ [INFO] [stdout] | |__________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:120:5 [INFO] [stdout] | [INFO] [stdout] 120 | / /// Returns volumetric Nusselt number [INFO] [stdout] 121 | | /// $$ [INFO] [stdout] 122 | | /// Nuvol = \langle uy*T/kappa - dTdz \rangle\\_V [INFO] [stdout] 123 | | /// $$ [INFO] [stdout] 124 | | /// [INFO] [stdout] 125 | | /// # Panics [INFO] [stdout] 126 | | /// If *ka* is not in params [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:140:5 [INFO] [stdout] | [INFO] [stdout] 140 | / /// Returns Reynolds number based on kinetic energy [INFO] [stdout] 141 | | /// [INFO] [stdout] 142 | | /// # Panics [INFO] [stdout] 143 | | /// If *nu* is not in params [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:157:1 [INFO] [stdout] | [INFO] [stdout] 157 | / impl Navier2DMpi<'_, T, S> [INFO] [stdout] 158 | | where [INFO] [stdout] 159 | | S: BaseSpace [INFO] [stdout] 160 | | + BaseSpaceMpi, [INFO] [stdout] ... | [INFO] [stdout] 188 | | } [INFO] [stdout] 189 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:163:5 [INFO] [stdout] | [INFO] [stdout] 163 | / /// Initialize velocity with fourier modes [INFO] [stdout] 164 | | /// [INFO] [stdout] 165 | | /// ux = amp \* sin(mx)cos(nx) [INFO] [stdout] 166 | | /// uy = -amp \* cos(mx)sin(nx) [INFO] [stdout] | |___________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:171:5 [INFO] [stdout] | [INFO] [stdout] 171 | / /// Initialize temperature with fourier modes [INFO] [stdout] 172 | | /// [INFO] [stdout] 173 | | /// temp = -amp \* cos(mx)sin(ny) [INFO] [stdout] | |_____________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:178:5 [INFO] [stdout] | [INFO] [stdout] 178 | /// Initialize all fields with random disturbances [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:191:1 [INFO] [stdout] | [INFO] [stdout] 191 | / impl<'a> Navier2DMpi<'_, f64, Space2R2r<'a>> [INFO] [stdout] 192 | | //where [INFO] [stdout] 193 | | // S: BaseSpace, [INFO] [stdout] 194 | | { [INFO] [stdout] ... | [INFO] [stdout] 336 | | } [INFO] [stdout] 337 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:195:5 [INFO] [stdout] | [INFO] [stdout] 195 | / /// Bases: Chebyshev in x & y [INFO] [stdout] 196 | | /// [INFO] [stdout] 197 | | /// Struct must be mutable, to perform the [INFO] [stdout] 198 | | /// update step, which advances the solution [INFO] [stdout] ... | [INFO] [stdout] 213 | | /// # Panics [INFO] [stdout] 214 | | /// 'bc' type not recognized, see Arguments [INFO] [stdout] | |_______________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:339:1 [INFO] [stdout] | [INFO] [stdout] 339 | / impl<'a> Navier2DMpi<'_, Complex, Space2R2c<'a>> [INFO] [stdout] 340 | | //where [INFO] [stdout] 341 | | // S: BaseSpace, [INFO] [stdout] 342 | | { [INFO] [stdout] ... | [INFO] [stdout] 486 | | } [INFO] [stdout] 487 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier.rs:343:5 [INFO] [stdout] | [INFO] [stdout] 343 | / /// Bases: Fourier in x and chebyshev in y [INFO] [stdout] 344 | | /// [INFO] [stdout] 345 | | /// Struct must be mutable, to perform the [INFO] [stdout] 346 | | /// update step, which advances the solution [INFO] [stdout] ... | [INFO] [stdout] 361 | | /// # Panics [INFO] [stdout] 362 | | /// 'bc' type not recognized, see Arguments [INFO] [stdout] | |_______________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/statistics.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Collect Statistics [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/statistics.rs:11:1 [INFO] [stdout] | [INFO] [stdout] 11 | /// Collection of fields for statistics [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/statistics.rs:39:1 [INFO] [stdout] | [INFO] [stdout] 39 | / impl Statistics [INFO] [stdout] 40 | | where [INFO] [stdout] 41 | | S: BaseSpace, [INFO] [stdout] 42 | | T: std::ops::Add [INFO] [stdout] ... | [INFO] [stdout] 108 | | } [INFO] [stdout] 109 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/statistics.rs:48:5 [INFO] [stdout] | [INFO] [stdout] 48 | /// Allocate statistics [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/statistics.rs:78:5 [INFO] [stdout] | [INFO] [stdout] 78 | / /// Update Statistics [INFO] [stdout] 79 | | /// [INFO] [stdout] 80 | | /// # Panics [INFO] [stdout] 81 | | /// If *ka* is not in params [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/statistics.rs:111:1 [INFO] [stdout] | [INFO] [stdout] 111 | / impl Statistics [INFO] [stdout] 112 | | where [INFO] [stdout] 113 | | S: BaseSpace, [INFO] [stdout] 114 | | Field2: ReadWrite, [INFO] [stdout] ... | [INFO] [stdout] 177 | | } [INFO] [stdout] 178 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/statistics.rs:116:5 [INFO] [stdout] | [INFO] [stdout] 116 | / /// Read fields [INFO] [stdout] 117 | | /// # Errors [INFO] [stdout] 118 | | /// Failed to read [INFO] [stdout] | |______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/statistics.rs:131:5 [INFO] [stdout] | [INFO] [stdout] 131 | /// Read snapshot from file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/statistics.rs:141:5 [INFO] [stdout] | [INFO] [stdout] 141 | / /// Write snapshot to file [INFO] [stdout] 142 | | /// # Errors [INFO] [stdout] 143 | | /// Failed to write [INFO] [stdout] | |_______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/statistics.rs:161:5 [INFO] [stdout] | [INFO] [stdout] 161 | /// Write snapshot to file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_eq.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Implement equations for navier-stokes simulations [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_eq.rs:14:1 [INFO] [stdout] | [INFO] [stdout] 14 | /// General [INFO] [stdout] | ^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_eq.rs:21:5 [INFO] [stdout] | [INFO] [stdout] 21 | /// Divergence: duxdx + duydy [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_eq.rs:37:1 [INFO] [stdout] | [INFO] [stdout] 37 | /// Return L2 norm of divergence [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_eq.rs:39:5 [INFO] [stdout] | [INFO] [stdout] 39 | /// Return L2 norm of divergence [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_eq.rs:69:1 [INFO] [stdout] | [INFO] [stdout] 69 | /// Convection [INFO] [stdout] | ^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_eq.rs:121:1 [INFO] [stdout] | [INFO] [stdout] 121 | /// Pressure update [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_eq.rs:146:1 [INFO] [stdout] | [INFO] [stdout] 146 | / impl Navier2DMpi<'_, T, S> [INFO] [stdout] 147 | | where [INFO] [stdout] 148 | | S: BaseSpace [INFO] [stdout] 149 | | + BaseSpaceMpi, [INFO] [stdout] ... | [INFO] [stdout] 163 | | } [INFO] [stdout] 164 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_eq.rs:166:1 [INFO] [stdout] | [INFO] [stdout] 166 | /// Solve pressure field [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_eq.rs:188:1 [INFO] [stdout] | [INFO] [stdout] 188 | /// Solve momentum and temperature equations [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_io.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Implement io routines for `Navier2DMpi` [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_io.rs:13:1 [INFO] [stdout] | [INFO] [stdout] 13 | / impl Navier2DMpi<'_, T, S> [INFO] [stdout] 14 | | where [INFO] [stdout] 15 | | T: num_traits::Zero, [INFO] [stdout] 16 | | S: BaseSpace [INFO] [stdout] ... | [INFO] [stdout] 81 | | } [INFO] [stdout] 82 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_io.rs:20:5 [INFO] [stdout] | [INFO] [stdout] 20 | / /// Read snapshot from file [INFO] [stdout] 21 | | /// # Errors [INFO] [stdout] 22 | | /// Failed to read [INFO] [stdout] | |______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_io.rs:38:5 [INFO] [stdout] | [INFO] [stdout] 38 | /// Read snapshot from file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_io.rs:48:5 [INFO] [stdout] | [INFO] [stdout] 48 | / /// Write snapshot to file [INFO] [stdout] 49 | | /// # Errors [INFO] [stdout] 50 | | /// Failed to write [INFO] [stdout] | |_______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_io.rs:75:5 [INFO] [stdout] | [INFO] [stdout] 75 | /// Write snapshot to file, and handle error [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_io.rs:84:1 [INFO] [stdout] | [INFO] [stdout] 84 | / impl<'a, T, S> Navier2DMpi<'a, T, S> [INFO] [stdout] 85 | | where [INFO] [stdout] 86 | | S: BaseSpace + BaseSpaceMpi, [INFO] [stdout] 87 | | Field2Mpi: ReadWrite, [INFO] [stdout] ... | [INFO] [stdout] 143 | | } [INFO] [stdout] 144 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/navier_stokes_mpi/navier_io.rs:91:5 [INFO] [stdout] | [INFO] [stdout] 91 | / /// Define all I/O related routines for `Navier2DLnse` [INFO] [stdout] 92 | | /// [INFO] [stdout] 93 | | /// # Panics [INFO] [stdout] 94 | | /// If folder `data` or file `info_name` cannot be created [INFO] [stdout] | |______________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! # Collection of linear algebra Solver [INFO] [stdout] 2 | | //! [INFO] [stdout] 3 | | //! Must be updated ... [INFO] [stdout] | |_______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/fdma.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Four-diagonal matrix solver [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/fdma.rs:9:1 [INFO] [stdout] | [INFO] [stdout] 9 | /// Solve banded system with diagonals-offsets: -2, 0, 2, 4 [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/fdma.rs:26:1 [INFO] [stdout] | [INFO] [stdout] 26 | / impl Fdma [INFO] [stdout] 27 | | where [INFO] [stdout] 28 | | T: SolverScalar, [INFO] [stdout] 29 | | { [INFO] [stdout] ... | [INFO] [stdout] 118 | | } [INFO] [stdout] 119 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/fdma.rs:30:5 [INFO] [stdout] | [INFO] [stdout] 30 | / /// Initialize Fdma from matrix. [INFO] [stdout] 31 | | /// Extracts the diagonals. [INFO] [stdout] 32 | | /// Precomputes the forward sweep. [INFO] [stdout] | |______________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/fdma.rs:39:5 [INFO] [stdout] | [INFO] [stdout] 39 | / /// Initialize Fdma from matrix. [INFO] [stdout] 40 | | /// Extracts only diagonals; no forward sweep is performed. [INFO] [stdout] 41 | | /// Note that self.solve, for performance reasons, does not [INFO] [stdout] 42 | | /// do the `forward_sweep` itself. So, if `from_matrix_raw` [INFO] [stdout] 43 | | /// is used, this step must be executed manually before solve [INFO] [stdout] | |_________________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/fdma.rs:55:5 [INFO] [stdout] | [INFO] [stdout] 55 | / /// Initialize `Fdma` from diagonals [INFO] [stdout] 56 | | /// Precomputes the forward sweep. [INFO] [stdout] | |______________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/fdma.rs:70:5 [INFO] [stdout] | [INFO] [stdout] 70 | / /// Precompute forward sweep. [INFO] [stdout] 71 | | /// The Arrays l,m,u1,u2 will deviate from the [INFO] [stdout] 72 | | /// diagonals of the original matrix. [INFO] [stdout] | |_________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/fdma.rs:91:5 [INFO] [stdout] | [INFO] [stdout] 91 | / /// Banded matrix solver [INFO] [stdout] 92 | | /// Ax = b [INFO] [stdout] 93 | | /// where A is banded with diagonals in offsets -2, 0, 2, 4 [INFO] [stdout] 94 | | /// [INFO] [stdout] ... | [INFO] [stdout] 97 | | /// u1: sub-diagonal (+2) [INFO] [stdout] 98 | | /// u2: sub-diagonal (+2) [INFO] [stdout] | |_____________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/fdma_tensor.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! Four-diagonal matrix solver for multidimensional problems [INFO] [stdout] 2 | | //! [INFO] [stdout] 3 | | //! Only one dimension needs to be four-diagonal. All other [INFO] [stdout] 4 | | //! dimensions are diagonalized by an eigendecomposition. This [INFO] [stdout] 5 | | //! adds two matrix multiplications per dimension to the solve [INFO] [stdout] 6 | | //! step, one before the fdma solver, and one after. [INFO] [stdout] | |____________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/fdma_tensor.rs:17:1 [INFO] [stdout] | [INFO] [stdout] 17 | / /// Tensor solver handles non-seperable multidimensional [INFO] [stdout] 18 | | /// systems, by diagonalizing all, but one, dimension [INFO] [stdout] 19 | | /// via a eigendecomposition. This makes the problem, [INFO] [stdout] 20 | | /// banded along the not-diagonalized direction. [INFO] [stdout] ... | [INFO] [stdout] 70 | | /// [INFO] [stdout] 71 | | /// g = Qx ghat = self.q.dot(ghat) [INFO] [stdout] | |_____________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/fdma_tensor.rs:91:1 [INFO] [stdout] | [INFO] [stdout] 91 | / impl FdmaTensor { [INFO] [stdout] 92 | | /// Supply array of matrices a and c, as defined in the definition of `FdmaTensor`. [INFO] [stdout] 93 | | /// [INFO] [stdout] 94 | | /// Eigendecompoiton: [INFO] [stdout] ... | [INFO] [stdout] 154 | | } [INFO] [stdout] 155 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/fdma_tensor.rs:92:5 [INFO] [stdout] | [INFO] [stdout] 92 | / /// Supply array of matrices a and c, as defined in the definition of `FdmaTensor`. [INFO] [stdout] 93 | | /// [INFO] [stdout] 94 | | /// Eigendecompoiton: [INFO] [stdout] 95 | | /// [INFO] [stdout] ... | [INFO] [stdout] 103 | | /// [INFO] [stdout] 104 | | /// In this case, only a, which must be a banded matrix, is used in solve. [INFO] [stdout] | |______________________________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/hholtz.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! # Helmoltz Solver [INFO] [stdout] 2 | | //! Solve equations of the form: [INFO] [stdout] 3 | | //! [INFO] [stdout] 4 | | //! (I-c*D2) vhat = f [INFO] [stdout] ... | [INFO] [stdout] 17 | | //! of D2 (B2). In this case, the second equation is [INFO] [stdout] 18 | | //! solved, with A = B2. [INFO] [stdout] | |________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/hholtz.rs:27:1 [INFO] [stdout] | [INFO] [stdout] 27 | /// Container for Hholtz [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/hholtz.rs:38:1 [INFO] [stdout] | [INFO] [stdout] 38 | / impl Hholtz { [INFO] [stdout] 39 | | // /// Construct Helmholtz solver from field: [INFO] [stdout] 40 | | // /// [INFO] [stdout] 41 | | // /// (I-c*D2) vhat = A f [INFO] [stdout] ... | [INFO] [stdout] 100 | | } [INFO] [stdout] 101 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/hholtz.rs:63:5 [INFO] [stdout] | [INFO] [stdout] 63 | / /// Construct Helmholtz solver from field: [INFO] [stdout] 64 | | /// [INFO] [stdout] 65 | | /// (I-c*D2) vhat = A f [INFO] [stdout] | |____________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/hholtz_adi.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! # Helmoltz Solver [INFO] [stdout] 2 | | //! Solve equations of the form: [INFO] [stdout] 3 | | //! [INFO] [stdout] 4 | | //! (I-c*D2) vhat = f [INFO] [stdout] ... | [INFO] [stdout] 20 | | //! of D2 (B2). In this case, the second equation is [INFO] [stdout] 21 | | //! solved, with A = B2. [INFO] [stdout] | |________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/hholtz_adi.rs:31:1 [INFO] [stdout] | [INFO] [stdout] 31 | /// Container for `HholtzAdi` [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/hholtz_adi.rs:41:1 [INFO] [stdout] | [INFO] [stdout] 41 | / impl HholtzAdi { [INFO] [stdout] 42 | | /// Construct Helmholtz solver from field: [INFO] [stdout] 43 | | /// [INFO] [stdout] 44 | | /// (I-c*D2) vhat = A f [INFO] [stdout] ... | [INFO] [stdout] 76 | | } [INFO] [stdout] 77 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/hholtz_adi.rs:42:5 [INFO] [stdout] | [INFO] [stdout] 42 | / /// Construct Helmholtz solver from field: [INFO] [stdout] 43 | | /// [INFO] [stdout] 44 | | /// (I-c*D2) vhat = A f [INFO] [stdout] 45 | | /// [INFO] [stdout] 46 | | /// # Panics [INFO] [stdout] 47 | | /// If no solver type is defined for a given base. [INFO] [stdout] | |______________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/matvec.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Collection of (sparse) matrix/vector products [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/matvec.rs:9:1 [INFO] [stdout] | [INFO] [stdout] 9 | /// Collection of Matrix-Vector Product Solver [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/matvec.rs:74:1 [INFO] [stdout] | [INFO] [stdout] 74 | / /// Simple class to multiply n-dimensional vector [INFO] [stdout] 75 | | /// with a matrix along the first Axis. [INFO] [stdout] 76 | | /// [INFO] [stdout] 77 | | /// Uses ndarrays 'dot' for matrix multiplication. [INFO] [stdout] | |__________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/matvec.rs:83:1 [INFO] [stdout] | [INFO] [stdout] 83 | / impl MatVecDot { [INFO] [stdout] 84 | | /// Return new `MatVecDot` (wrapper around ndarray) [INFO] [stdout] 85 | | pub fn new(mat: &Array2) -> Self { [INFO] [stdout] 86 | | MatVecDot { [INFO] [stdout] ... | [INFO] [stdout] 89 | | } [INFO] [stdout] 90 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/matvec.rs:84:5 [INFO] [stdout] | [INFO] [stdout] 84 | /// Return new `MatVecDot` (wrapper around ndarray) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/matvec.rs:92:1 [INFO] [stdout] | [INFO] [stdout] 92 | / impl MatVecDot [INFO] [stdout] 93 | | where [INFO] [stdout] 94 | | T: SolverScalar, [INFO] [stdout] 95 | | { [INFO] [stdout] ... | [INFO] [stdout] 106 | | } [INFO] [stdout] 107 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/matvec.rs:158:1 [INFO] [stdout] | [INFO] [stdout] 158 | /// Use if Matrix is banded with offets -2, 0, 2, 4 [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/matvec.rs:175:1 [INFO] [stdout] | [INFO] [stdout] 175 | / impl MatVecFdma { [INFO] [stdout] 176 | | /// Initialize Fdma from matrix. [INFO] [stdout] 177 | | pub fn new(a: &Array2) -> Self { [INFO] [stdout] 178 | | let m = a.shape()[0]; [INFO] [stdout] ... | [INFO] [stdout] 228 | | } [INFO] [stdout] 229 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/matvec.rs:176:5 [INFO] [stdout] | [INFO] [stdout] 176 | /// Initialize Fdma from matrix. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/pdma_plus2.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Solve banded system with diagonals-offsets: -2, 1, 0, 1, 2, 3, 4 [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/pdma_plus2.rs:12:1 [INFO] [stdout] | [INFO] [stdout] 12 | / /// Solve banded system with diagonals-offsets: -2, 1, 0, 1, 2, 3, 4 [INFO] [stdout] 13 | | /// [INFO] [stdout] 14 | | /// # References [INFO] [stdout] 15 | | /// [INFO] [stdout] 16 | | /// [INFO] [stdout] 17 | | /// Slightly modified, with 2 more upper diagonals [INFO] [stdout] | |__________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/pdma_plus2.rs:38:1 [INFO] [stdout] | [INFO] [stdout] 38 | / impl PdmaPlus2 [INFO] [stdout] 39 | | where [INFO] [stdout] 40 | | T: SolverScalar, [INFO] [stdout] 41 | | { [INFO] [stdout] ... | [INFO] [stdout] 157 | | } [INFO] [stdout] 158 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/pdma_plus2.rs:42:5 [INFO] [stdout] | [INFO] [stdout] 42 | / /// Initialize `PdmaPlus2` from matrix. [INFO] [stdout] 43 | | /// Extracts the diagonals. [INFO] [stdout] 44 | | /// Precomputes the forward sweep. [INFO] [stdout] | |______________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/poisson.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! Poisson Solver [INFO] [stdout] 2 | | //! Solve equations of the form: [INFO] [stdout] 3 | | //! ..math: [INFO] [stdout] 4 | | //! c * D2 vhat = f [INFO] [stdout] ... | [INFO] [stdout] 20 | | //! of D2 (B2). In this case, the second equation is [INFO] [stdout] 21 | | //! solved, with A = B2. [INFO] [stdout] | |________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/poisson.rs:32:1 [INFO] [stdout] | [INFO] [stdout] 32 | /// Container for Poisson Solver [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/poisson.rs:39:1 [INFO] [stdout] | [INFO] [stdout] 39 | / impl Poisson { [INFO] [stdout] 40 | | /// Construct Poisson solver from field: [INFO] [stdout] 41 | | /// [INFO] [stdout] 42 | | /// [(D2x x Iy) + (Ix x D2y)] vhat = [(Ax x Iy) + (Ix + Ay)] f [INFO] [stdout] ... | [INFO] [stdout] 92 | | } [INFO] [stdout] 93 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/poisson.rs:40:5 [INFO] [stdout] | [INFO] [stdout] 40 | / /// Construct Poisson solver from field: [INFO] [stdout] 41 | | /// [INFO] [stdout] 42 | | /// [(D2x x Iy) + (Ix x D2y)] vhat = [(Ax x Iy) + (Ix + Ay)] f [INFO] [stdout] 43 | | /// [INFO] [stdout] ... | [INFO] [stdout] 50 | | /// diagonal by an eigendecomposition. This is entirely done in [INFO] [stdout] 51 | | /// the `FdmaTensor` solver. [INFO] [stdout] | |________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/sdma.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Diagonal matrix solver [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/sdma.rs:9:1 [INFO] [stdout] | [INFO] [stdout] 9 | /// Solve single diagonal system with diagonals-offsets: 0 [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/sdma.rs:18:1 [INFO] [stdout] | [INFO] [stdout] 18 | / impl Sdma { [INFO] [stdout] 19 | | /// Initialize Sdma from matrix. [INFO] [stdout] 20 | | /// Extracts the diagonals [INFO] [stdout] 21 | | pub fn from_matrix(a: &Array2) -> Self { [INFO] [stdout] ... | [INFO] [stdout] 46 | | } [INFO] [stdout] 47 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/sdma.rs:19:5 [INFO] [stdout] | [INFO] [stdout] 19 | / /// Initialize Sdma from matrix. [INFO] [stdout] 20 | | /// Extracts the diagonals [INFO] [stdout] | |______________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/tdma.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Tri-diagonal matrix solver [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/tdma.rs:9:1 [INFO] [stdout] | [INFO] [stdout] 9 | /// Solve tridiagonal system with diagonals-offsets: -2, 0, 2 [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/tdma.rs:22:1 [INFO] [stdout] | [INFO] [stdout] 22 | / impl Tdma { [INFO] [stdout] 23 | | /// Initialize Tdma from matrix. [INFO] [stdout] 24 | | /// Extracts the diagonals [INFO] [stdout] 25 | | pub fn from_matrix(a: &Array2) -> Self { [INFO] [stdout] ... | [INFO] [stdout] 82 | | } [INFO] [stdout] 83 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/tdma.rs:23:5 [INFO] [stdout] | [INFO] [stdout] 23 | / /// Initialize Tdma from matrix. [INFO] [stdout] 24 | | /// Extracts the diagonals [INFO] [stdout] | |______________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/utils.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Collection of usefull algebra methods [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/utils.rs:12:1 [INFO] [stdout] | [INFO] [stdout] 12 | / /// Return the diagonal of a one-dimensional array. [INFO] [stdout] 13 | | /// Parameter offset defines which diagonal is returned [INFO] [stdout] 14 | | /// ## Panics [INFO] [stdout] 15 | | /// Panics when input is not square or requested diag [INFO] [stdout] 16 | | /// is larger than matrix size. [INFO] [stdout] | |_______________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/utils.rs:101:1 [INFO] [stdout] | [INFO] [stdout] 101 | / /// Return inverse of square matrix [INFO] [stdout] 102 | | /// ## Panics [INFO] [stdout] 103 | | /// Panics when computation of inverse fails. [INFO] [stdout] | |_____________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver/utils.rs:230:1 [INFO] [stdout] | [INFO] [stdout] 230 | / /// Convert dynamically sized vector to static array [INFO] [stdout] 231 | | /// [INFO] [stdout] 232 | | /// ## Panics [INFO] [stdout] 233 | | /// Mismatching size of vector and array [INFO] [stdout] | |________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver.rs:28:1 [INFO] [stdout] | [INFO] [stdout] 28 | /// Combination of linear algebra traits [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver.rs:57:1 [INFO] [stdout] | [INFO] [stdout] 57 | /// Solve linear algebraix systems of the form: M x = b. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver.rs:60:5 [INFO] [stdout] | [INFO] [stdout] 60 | / /// Solves M x = b, returns x, which is of type A [INFO] [stdout] 61 | | /// Output (x) matches input (b) in type and size. [INFO] [stdout] | |______________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver.rs:68:5 [INFO] [stdout] | [INFO] [stdout] 68 | / /// Solves M x = b, returns x, which is of type A [INFO] [stdout] 69 | | /// Output (x) matches input (b) in type and size. [INFO] [stdout] 70 | | /// [INFO] [stdout] 71 | | /// Use parallel iteratiors for ndim > 1. Might be [INFO] [stdout] 72 | | /// unimplemented for some solvers. [INFO] [stdout] | |_______________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver.rs:84:1 [INFO] [stdout] | [INFO] [stdout] 84 | /// Solve linear algebraic systems of the form: M x = b. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver.rs:87:5 [INFO] [stdout] | [INFO] [stdout] 87 | / /// Solves M x = b, returns x, which is of type A [INFO] [stdout] 88 | | /// Output (x) matches input (b) in type and size. [INFO] [stdout] | |______________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver.rs:93:5 [INFO] [stdout] | [INFO] [stdout] 93 | /// Parallel version of solve. Might be unimplemented. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver.rs:99:1 [INFO] [stdout] | [INFO] [stdout] 99 | /// Collection of Linalg Solver, must work for unlimited number of dimensions [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver.rs:113:1 [INFO] [stdout] | [INFO] [stdout] 113 | /// Intented to solve field equations (limited number of dimensions) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver_mpi.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Mpi supported solvers [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver_mpi/hholtz.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! # Helmoltz Solver with mpi support [INFO] [stdout] 2 | | //! Solve equations of the form: [INFO] [stdout] 3 | | //! [INFO] [stdout] 4 | | //! (I-c*D2) vhat = f [INFO] [stdout] ... | [INFO] [stdout] 17 | | //! of D2 (B2). In this case, the second equation is [INFO] [stdout] 18 | | //! solved, with A = B2. [INFO] [stdout] | |________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver_mpi/hholtz.rs:29:1 [INFO] [stdout] | [INFO] [stdout] 29 | /// Container for Poisson Solver [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver_mpi/hholtz.rs:37:1 [INFO] [stdout] | [INFO] [stdout] 37 | / impl HholtzMpi { [INFO] [stdout] 38 | | /// Construct Helmholtz solver from field: [INFO] [stdout] 39 | | /// [INFO] [stdout] 40 | | /// (I-c*D2) vhat = A f [INFO] [stdout] ... | [INFO] [stdout] 79 | | } [INFO] [stdout] 80 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver_mpi/hholtz.rs:38:5 [INFO] [stdout] | [INFO] [stdout] 38 | / /// Construct Helmholtz solver from field: [INFO] [stdout] 39 | | /// [INFO] [stdout] 40 | | /// (I-c*D2) vhat = A f [INFO] [stdout] | |____________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver_mpi/hholtz_adi.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! # Helmoltz Solver with mpi support [INFO] [stdout] 2 | | //! [INFO] [stdout] 3 | | //! Input: x pencil distributed data in spectral space. [INFO] [stdout] 4 | | //! [INFO] [stdout] ... | [INFO] [stdout] 27 | | //! of D2 (B2). In this case, the second equation is [INFO] [stdout] 28 | | //! solved, with A = B2. [INFO] [stdout] | |________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver_mpi/hholtz_adi.rs:40:1 [INFO] [stdout] | [INFO] [stdout] 40 | / /// Container for `HholtzAdi` [INFO] [stdout] 41 | | /// Solve with mpi support. Input must be x pencil distribution. [INFO] [stdout] | |________________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver_mpi/hholtz_adi.rs:49:1 [INFO] [stdout] | [INFO] [stdout] 49 | / impl HholtzAdiMpi [INFO] [stdout] 50 | | where [INFO] [stdout] 51 | | S: BaseSpace + BaseSpaceMpi, [INFO] [stdout] 52 | | { [INFO] [stdout] ... | [INFO] [stdout] 89 | | } [INFO] [stdout] 90 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver_mpi/hholtz_adi.rs:53:5 [INFO] [stdout] | [INFO] [stdout] 53 | / /// Construct Helmholtz solver from field: [INFO] [stdout] 54 | | /// [INFO] [stdout] 55 | | /// (I-c*D2) vhat = A f [INFO] [stdout] 56 | | /// [INFO] [stdout] 57 | | /// # Panics [INFO] [stdout] 58 | | /// If no solver type is defined for a given base. [INFO] [stdout] | |______________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver_mpi/poisson.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! Poisson Solver with mpi support [INFO] [stdout] 2 | | //! [INFO] [stdout] 3 | | //! Input: x pencil distributed data in spectral space. [INFO] [stdout] 4 | | //! [INFO] [stdout] ... | [INFO] [stdout] 27 | | //! of D2 (B2). In this case, the second equation is [INFO] [stdout] 28 | | //! solved, with A = B2. [INFO] [stdout] | |________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver_mpi/poisson.rs:39:1 [INFO] [stdout] | [INFO] [stdout] 39 | /// Container for Poisson Solver [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver_mpi/poisson.rs:47:1 [INFO] [stdout] | [INFO] [stdout] 47 | / impl PoissonMpi { [INFO] [stdout] 48 | | /// Construct Poisson solver from field: [INFO] [stdout] 49 | | /// [INFO] [stdout] 50 | | /// [(D2x x Iy) + (Ix x D2y)] vhat = [(Ax x Iy) + (Ix + Ay)] f [INFO] [stdout] ... | [INFO] [stdout] 105 | | } [INFO] [stdout] 106 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/solver_mpi/poisson.rs:48:5 [INFO] [stdout] | [INFO] [stdout] 48 | / /// Construct Poisson solver from field: [INFO] [stdout] 49 | | /// [INFO] [stdout] 50 | | /// [(D2x x Iy) + (Ix x D2y)] vhat = [(Ax x Iy) + (Ix + Ay)] f [INFO] [stdout] 51 | | /// [INFO] [stdout] ... | [INFO] [stdout] 60 | | /// [INFO] [stdout] 61 | | /// Solve with mpi support. Input must be x pencil distribution. [INFO] [stdout] | |____________________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/types.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Types and traits for real and complex numbers [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/types.rs:6:1 [INFO] [stdout] | [INFO] [stdout] 6 | /// Scalar type, used throughout this crate for arithmetic operations [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/lib.rs:173:1 [INFO] [stdout] | [INFO] [stdout] 173 | /// Integrate trait, step forward in time, and write results [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/lib.rs:175:5 [INFO] [stdout] | [INFO] [stdout] 175 | /// Update solution [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/lib.rs:177:5 [INFO] [stdout] | [INFO] [stdout] 177 | /// Receive current time [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/lib.rs:179:5 [INFO] [stdout] | [INFO] [stdout] 179 | /// Get timestep [INFO] [stdout] | ^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/lib.rs:181:5 [INFO] [stdout] | [INFO] [stdout] 181 | /// Callback function (can be used for i/o) [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/lib.rs:183:5 [INFO] [stdout] | [INFO] [stdout] 183 | /// Additional break criteria [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: missing code example in this documentation [INFO] [stdout] --> src/lib.rs:187:1 [INFO] [stdout] | [INFO] [stdout] 187 | / /// Integrade pde, that implements the Integrate trait. [INFO] [stdout] 188 | | /// [INFO] [stdout] 189 | | /// Specify `save_intervall` to force writing an output. [INFO] [stdout] 190 | | /// [INFO] [stdout] 191 | | /// Stop Criteria: [INFO] [stdout] 192 | | /// 1. Timestep limit [INFO] [stdout] 193 | | /// 2. Time limit [INFO] [stdout] | |_________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] warning: 451 warnings emitted [INFO] [stdout] [INFO] [stdout] [INFO] [stderr] Finished dev [unoptimized + debuginfo] target(s) in 1m 30s [INFO] running `Command { std: "docker" "inspect" "28a47a6946632d9d032f978892893725012bf2dc3c4af007f1d75faf29c8b5a1", kill_on_drop: false }` [INFO] running `Command { std: "docker" "rm" "-f" "28a47a6946632d9d032f978892893725012bf2dc3c4af007f1d75faf29c8b5a1", kill_on_drop: false }` [INFO] [stdout] 28a47a6946632d9d032f978892893725012bf2dc3c4af007f1d75faf29c8b5a1 [INFO] running `Command { std: "docker" "create" "-v" "/var/lib/crater-agent-workspace/builds/worker-61/target:/opt/rustwide/target:rw,Z" "-v" "/var/lib/crater-agent-workspace/builds/worker-61/source:/opt/rustwide/workdir:ro,Z" "-v" "/var/lib/crater-agent-workspace/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/var/lib/crater-agent-workspace/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "CARGO_INCREMENTAL=0" "-e" "RUST_BACKTRACE=full" "-e" "RUSTFLAGS=--cap-lints=forbid" "-e" "DOCS_RS=1" "-e" "RUSTC_BOOTSTRAP=1" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "-m" "1610612736" "--user" "0:0" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:d190cb871061d98bc6d0581d85cb2ecb09a0f8a142ba5463de30be9999fc3251" "/opt/rustwide/cargo-home/bin/cargo" "+e1df625306f4136949e02612406f0c60df6008f3" "rustdoc" "--lib" "-Zrustdoc-map" "--frozen" "--message-format=json" "--" "-Z" "unstable-options" "--document-private-items", kill_on_drop: false }` [INFO] [stdout] 8473cfe5b53c6c887b20548bfc0f5a0402abb09ad3f6d050609ae1ecd867ac05 [INFO] running `Command { std: "docker" "start" "-a" "8473cfe5b53c6c887b20548bfc0f5a0402abb09ad3f6d050609ae1ecd867ac05", kill_on_drop: false }` [INFO] [stderr] Blocking waiting for file lock on package cache [INFO] [stderr] Compiling libc v0.2.110 [INFO] [stderr] Compiling autocfg v1.0.1 [INFO] [stderr] Checking cfg-if v1.0.0 [INFO] [stderr] Compiling libm v0.2.1 [INFO] [stderr] Compiling memchr v2.4.1 [INFO] [stderr] Compiling proc-macro2 v1.0.33 [INFO] [stderr] Checking ppv-lite86 v0.2.15 [INFO] [stderr] Compiling unicode-xid v0.2.2 [INFO] [stderr] Compiling serde v1.0.131 [INFO] [stderr] Compiling syn v1.0.82 [INFO] [stderr] Compiling pkg-config v0.3.23 [INFO] [stderr] Compiling crossbeam-utils v0.8.5 [INFO] [stderr] Checking lazy_static v1.4.0 [INFO] [stderr] Checking scopeguard v1.1.0 [INFO] [stderr] Compiling crossbeam-epoch v0.9.5 [INFO] [stderr] Compiling rayon-core v1.9.1 [INFO] [stderr] Compiling glob v0.2.11 [INFO] [stderr] Compiling log v0.4.14 [INFO] [stderr] Compiling regex-syntax v0.6.25 [INFO] [stderr] Compiling regex v0.2.11 [INFO] [stderr] Compiling ucd-util v0.1.8 [INFO] [stderr] Compiling libloading v0.4.3 [INFO] [stderr] Compiling same-file v1.0.6 [INFO] [stderr] Compiling unicode-width v0.1.9 [INFO] [stderr] Compiling utf8-ranges v1.0.4 [INFO] [stderr] Checking rawpointer v0.2.1 [INFO] [stderr] Compiling ansi_term v0.12.1 [INFO] [stderr] Compiling bindgen v0.31.3 [INFO] [stderr] Checking either v1.6.1 [INFO] [stderr] Compiling vec_map v0.8.2 [INFO] [stderr] Compiling bitflags v1.3.2 [INFO] [stderr] Compiling strsim v0.8.0 [INFO] [stderr] Compiling cfg-if v0.1.10 [INFO] [stderr] Compiling libffi-sys v1.3.0 [INFO] [stderr] Compiling lazy_static v0.2.11 [INFO] [stderr] Compiling peeking_take_while v0.1.2 [INFO] [stderr] Checking strength_reduce v0.2.3 [INFO] [stderr] Checking smallvec v1.7.0 [INFO] [stderr] Compiling quote v0.3.15 [INFO] [stderr] Compiling cc v1.0.72 [INFO] [stderr] Compiling parking_lot_core v0.8.5 [INFO] [stderr] Checking abort_on_panic v2.0.0 [INFO] [stderr] Compiling hdf5-types v0.8.1 [INFO] [stderr] Checking custom_derive v0.1.7 [INFO] [stderr] Compiling once_cell v1.8.0 [INFO] [stderr] Checking ascii v1.0.0 [INFO] [stderr] Compiling hdf5 v0.8.1 [INFO] [stderr] Compiling paste v1.0.6 [INFO] [stderr] Compiling libloading v0.7.2 [INFO] [stderr] Checking instant v0.1.12 [INFO] [stderr] error: could not compile `regex-syntax` [INFO] [stderr] [INFO] [stderr] Caused by: [INFO] [stderr] process didn't exit successfully: `rustc --crate-name regex_syntax --edition=2018 /opt/rustwide/cargo-home/registry/src/github.com-1ecc6299db9ec823/regex-syntax-0.6.25/src/lib.rs --error-format=json --json=diagnostic-rendered-ansi,artifacts,future-incompat --crate-type lib --emit=dep-info,metadata,link -C embed-bitcode=no -C debuginfo=2 --cfg 'feature="default"' --cfg 'feature="unicode"' --cfg 'feature="unicode-age"' --cfg 'feature="unicode-bool"' --cfg 'feature="unicode-case"' --cfg 'feature="unicode-gencat"' --cfg 'feature="unicode-perl"' --cfg 'feature="unicode-script"' --cfg 'feature="unicode-segment"' -C metadata=c25dc19d7487cdf7 -C extra-filename=-c25dc19d7487cdf7 --out-dir /opt/rustwide/target/debug/deps -L dependency=/opt/rustwide/target/debug/deps --cap-lints allow --cap-lints=forbid` (signal: 9, SIGKILL: kill) [INFO] [stderr] warning: build failed, waiting for other jobs to finish... [INFO] running `Command { std: "docker" "inspect" "8473cfe5b53c6c887b20548bfc0f5a0402abb09ad3f6d050609ae1ecd867ac05", kill_on_drop: false }` [INFO] running `Command { std: "docker" "rm" "-f" "8473cfe5b53c6c887b20548bfc0f5a0402abb09ad3f6d050609ae1ecd867ac05", kill_on_drop: false }` [INFO] [stdout] 8473cfe5b53c6c887b20548bfc0f5a0402abb09ad3f6d050609ae1ecd867ac05