Skip to main content

Module prelude

Module prelude 

Source
Expand description

Convenience re-exports of the most commonly used types and functions.

Re-exportsยง

pub use crate::primitives::GREAT;
pub use crate::primitives::ROOT_GREAT;
pub use crate::primitives::ROOT_SMALL;
pub use crate::primitives::ROOT_VSMALL;
pub use crate::primitives::SMALL;
pub use crate::primitives::VGREAT;
pub use crate::primitives::VSMALL;
pub use crate::primitives::SphericalTensor;
pub use crate::primitives::SymmTensor;
pub use crate::primitives::Tensor;
pub use crate::primitives::Vector3;
pub use crate::primitives::eigen_values;
pub use crate::primitives::eigen_values_checked;
pub use crate::primitives::eigen_values_symm;
pub use crate::primitives::eigen_vectors;
pub use crate::primitives::eigen_vectors_symm;
pub use crate::primitives::eigen_vectors_symm_with;
pub use crate::primitives::eigen_vectors_with;
pub use crate::polynomial::CubicEqn;
pub use crate::polynomial::LinearEqn;
pub use crate::polynomial::Polynomial;
pub use crate::polynomial::QuadraticEqn;
pub use crate::polynomial::RootType;
pub use crate::polynomial::Roots;
pub use crate::math::erf_inv;
pub use crate::math::erf_inv;
pub use crate::math::inc_gamma_p;
pub use crate::math::inc_gamma_q;
pub use crate::math::inc_gamma_ratio_p;
pub use crate::math::inc_gamma_ratio_q;
pub use crate::math::inv_inc_gamma;
pub use crate::math::inv_inc_gamma;
pub use crate::matrix::MatrixError;
pub use crate::matrix::SquareMatrix;
pub use crate::ode::DynSystemIntegrator;
pub use crate::ode::Euler;
pub use crate::ode::NoTypedSystem;
pub use crate::ode::OdeError;
pub use crate::ode::OdeIntegrator;
pub use crate::ode::OdeSolver;
pub use crate::ode::OdeSolverConfig;
pub use crate::ode::OdeSystem;
pub use crate::ode::Rkf45;
pub use crate::ode::Rosenbrock23;
pub use crate::ode::SharedOdeSystem;
pub use crate::ode::TypedStateIntegrator;
pub use crate::interpolation::interpolate_spline_xy;
pub use crate::interpolation::interpolate_spline_xy;
pub use crate::interpolation::interpolate_xy;
pub use crate::interpolation::interpolate_xy;
pub use crate::thermophysics::error::ThermoError;
pub use crate::thermophysics::quantities::Compressibility;
pub use crate::fields::BoundaryCondition;
pub use crate::fields::Field;
pub use crate::fields::PatchField;
pub use crate::fields::SurfaceField;
pub use crate::fields::SurfaceScalarField;
pub use crate::fields::SurfaceVectorField;
pub use crate::fields::VolField;
pub use crate::fields::VolScalarField;
pub use crate::fields::VolSymmTensorField;
pub use crate::fields::VolTensorField;
pub use crate::fields::VolVectorField;
pub use crate::mesh::AmiCoupling;
pub use crate::mesh::AmiOverlap;
pub use crate::mesh::AmiWeight;
pub use crate::mesh::BoundaryPatch;
pub use crate::mesh::CyclicCoupling;
pub use crate::mesh::FvMesh;
pub use crate::mesh::FvMeshBuilder;
pub use crate::mesh::MeshError;
pub use crate::mesh::PatchKind;
pub use crate::mesh::RegionInterface;
pub use crate::mesh::ami::overlap_weights_1d;
pub use crate::ldu_matrix::FvMatrix;
pub use crate::ldu_matrix::FvVectorMatrix;
pub use crate::ldu_matrix::LduMatrix;
pub use crate::ldu_matrix::SolverPerformance;
pub use crate::ldu_matrix::SolverSettings;
pub use crate::fv_operators::adjust_phi;
pub use crate::fv_operators::fvc;
pub use crate::fv_operators::fvm;
pub use crate::fv_operators::fvc::central_upwind::KnpFaceFlux;
pub use crate::fv_operators::fvc::central_upwind::KnpFaceState;
pub use crate::fv_operators::fvc::central_upwind::KnpWaveSpeeds;
pub use crate::fv_operators::fvc::grad_least_squares;
pub use crate::fv_operators::fvm::laplacian_corrected;
pub use crate::fv_operators::fvm::max_non_orthogonality_deg;
pub use crate::fv_operators::fvm::non_ortho_geometry;
pub use crate::fv_operators::fvm::solve_laplacian_non_orthogonal;
pub use crate::fv_operators::fvm::NonOrthoGeometry;
pub use crate::fv_operators::fvm::NonOrthoScheme;
pub use crate::fv_options::CellSelection;
pub use crate::fv_options::EquationField;
pub use crate::fv_options::FvModel;
pub use crate::fv_options::FvModels;
pub use crate::fv_options::MomentumEquationForm;
pub use crate::fv_options::SemiImplicitSource;
pub use crate::fv_options::SolidificationMelting;
pub use crate::fv_options::SolidificationMeltingCoefficients;
pub use crate::fv_options::SolidificationPorosity;
pub use crate::fv_options::SourceContribution;
pub use crate::fv_options::TemperatureTable;
pub use crate::fv_options::VofSolidificationMelting;
pub use crate::fields::vol_field_algebra;
pub use crate::fluid_thermo::ConstSolidThermo;
pub use crate::fluid_thermo::FluidThermo;
pub use crate::fluid_thermo::PsiThermo;
pub use crate::fluid_thermo::RhoThermo;
pub use crate::fluid_thermo::SolidThermo;
pub use crate::ldu_matrix::conjugate_gradient;
pub use crate::ldu_matrix::conjugate_gradient;
pub use crate::ldu_matrix::gamg;
pub use crate::ldu_matrix::gamg;
pub use crate::ldu_matrix::gauss_seidel;
pub use crate::ldu_matrix::gauss_seidel;
pub use crate::ldu_matrix::krylov_solve;
pub use crate::ldu_matrix::krylov_solve_prepared;
pub use crate::ldu_matrix::KrylovMethod;
pub use crate::ldu_matrix::KrylovOptions;
pub use crate::ldu_matrix::PreconditionerKind;
pub use crate::krylov::bicgstab;
pub use crate::krylov::bicgstab_prepared;
pub use crate::krylov::gmres;
pub use crate::krylov::gmres_prepared;
pub use crate::krylov::Ilu0Preconditioner;
pub use crate::krylov::JacobiPreconditioner;
pub use crate::krylov::KrylovResult;
pub use crate::krylov::KrylovSettings;
pub use crate::krylov::Preconditioner;
pub use crate::interface;
pub use crate::steady_conduction::radial_mesh;
pub use crate::steady_conduction::voxel_mesh;
pub use crate::steady_conduction::ConductionMesh;
pub use crate::steady_conduction::EnergyBalance;
pub use crate::steady_conduction::PatchCondition;
pub use crate::steady_conduction::RadialClosedForm;
pub use crate::steady_conduction::RadialGeometry;
pub use crate::steady_conduction::RadialLayer;
pub use crate::steady_conduction::RadialShell;
pub use crate::steady_conduction::SteadyConductionError;
pub use crate::steady_conduction::SteadyConductionProblem;
pub use crate::steady_conduction::SteadyConductionSettings;
pub use crate::steady_conduction::SteadyConductionSolution;
pub use crate::steady_conduction::ThermalBoundary;
pub use crate::steady_conduction::VoxelGrid;
pub use crate::steady_conduction::VoxelMesh;
pub use crate::limiters::FluxLimiter;
pub use crate::compute::gpu_adapter_present;
pub use crate::compute::select_backend;
pub use crate::compute::ComputeBackend;
pub use crate::compute::ThreadCount;
pub use crate::compute::CPU_MULTI_MIN_WORK_ITEMS;
pub use crate::compute::GPU_MIN_WORK_ITEMS;
pub use crate::fields::parallel::field_parallel_crossover;
pub use crate::fields::parallel::should_parallelise;
pub use crate::fields::parallel::FIELD_PARALLEL_CROSSOVER;
pub use crate::fields::parallel::REDUCTION_CHUNK;
pub use crate::ldu_matrix::parallel::axpy as ldu_axpy;
pub use crate::ldu_matrix::parallel::dot as ldu_dot;
pub use crate::ldu_matrix::parallel::norm_l1 as ldu_norm_l1;
pub use crate::ldu_matrix::parallel::norm_l2 as ldu_norm_l2;
pub use crate::ldu_matrix::parallel::scale as ldu_scale;
pub use crate::ldu_matrix::parallel::spmv_backend_for;
pub use crate::ldu_matrix::parallel::vecop_backend_for;
pub use crate::ldu_matrix::parallel::HybridLdu;
pub use crate::ldu_matrix::parallel::LduTopology;
pub use crate::ldu_matrix::parallel::CELL_BLOCK;
pub use crate::ldu_matrix::parallel::REDUCTION_BLOCK;
pub use crate::ldu_matrix::parallel::SPMV_MIN_CELLS;
pub use crate::ldu_matrix::parallel::VECOP_MIN_ELEMENTS;
pub use crate::math::parallel::cubic_roots_batch;
pub use crate::math::parallel::linear_roots_batch;
pub use crate::math::parallel::poly_roots_backend_for;
pub use crate::math::parallel::quadratic_roots_batch;
pub use crate::math::parallel::root_batch_backend_for;
pub use crate::math::parallel::solve_bracketed_batch;
pub use crate::math::parallel::solve_newton_batch;
pub use crate::math::parallel::RootBatch;
pub use crate::math::parallel::RootBatchFailure;
pub use crate::math::parallel::RootMethod;
pub use crate::math::parallel::RootProblem;
pub use crate::math::parallel::RootSettings;
pub use crate::math::parallel::RootSolution;
pub use crate::math::parallel::RootStatus;
pub use crate::math::minimise::golden_section_batch;
pub use crate::math::minimise::minimise_backend_for;
pub use crate::math::minimise::MinBatch;
pub use crate::math::minimise::MinBatchFailure;
pub use crate::math::minimise::MinProblem;
pub use crate::math::minimise::MinSettings;
pub use crate::math::minimise::MinSolution;
pub use crate::math::minimise::MinStatus;
pub use crate::math::minimise::Sense;
pub use crate::math::minimise::GOLDEN_RATIO;
pub use crate::math::minimise::MINIMISE_BATCH_MIN_PROBLEMS;
pub use crate::math::minimise::SQRT_EPSILON;
pub use crate::ode::parallel::adaptive_quadrature_batch;
pub use crate::ode::parallel::ensemble_backend_for;
pub use crate::ode::parallel::integrate_ensemble;
pub use crate::ode::parallel::integrate_ensemble_mixed;
pub use crate::ode::parallel::quadrature_backend_for;
pub use crate::ode::parallel::quadrature_batch;
pub use crate::ode::parallel::AdaptiveSettings;
pub use crate::ode::parallel::GaussOrder;
pub use crate::ode::parallel::OdeEnsemble;
pub use crate::ode::parallel::OdeEnsembleFailure;
pub use crate::ode::parallel::OdeLane;
pub use crate::ode::parallel::OdeLaneSolution;
pub use crate::ode::parallel::OdeLaneStatus;
pub use crate::ode::parallel::QuadratureBatch;
pub use crate::ode::parallel::QuadratureBatchFailure;
pub use crate::ode::parallel::QuadratureInterval;
pub use crate::ode::parallel::QuadratureRule;
pub use crate::ode::parallel::QuadratureSolution;
pub use crate::ode::parallel::QuadratureStatus;
pub use crate::ode::parallel::ODE_ENSEMBLE_MIN_LANES;
pub use crate::ode::parallel::QUADRATURE_MIN_INTERVALS;
pub use crate::math::differentiate::derivative;
pub use crate::math::differentiate::derivative_backend_for;
pub use crate::math::differentiate::derivative_batch;
pub use crate::math::differentiate::jacobian;
pub use crate::math::differentiate::jacobian_batch;
pub use crate::math::differentiate::jacobian_batch_backend_for;
pub use crate::math::differentiate::jacobian_column_backend_for;
pub use crate::math::differentiate::ode_system_jacobian;
pub use crate::math::differentiate::DerivativeBatch;
pub use crate::math::differentiate::DerivativeSolution;
pub use crate::math::differentiate::DiffBatchFailure;
pub use crate::math::differentiate::DiffScheme;
pub use crate::math::differentiate::DiffSettings;
pub use crate::math::differentiate::DiffStatus;
pub use crate::math::differentiate::JacobianBatch;
pub use crate::math::differentiate::JacobianSolution;
pub use crate::math::differentiate::NumericalJacobian;
pub use crate::math::differentiate::CBRT_EPSILON;
pub use crate::math::differentiate::DERIVATIVE_BATCH_MIN_POINTS;
pub use crate::math::differentiate::FIFTH_ROOT_EPSILON;
pub use crate::math::differentiate::JACOBIAN_BATCH_MIN_PROBLEMS;
pub use crate::math::differentiate::JACOBIAN_COLUMN_MIN_DIMENSION;
pub use crate::thermophysics::eos::*;
pub use crate::thermophysics::thermo::*;
pub use crate::thermophysics::transport::*;