Struct HyperRelaxSolver 

pub struct HyperRelaxSolver {
    pub tolerance: f64,
    pub max_steps: usize,
    pub dampening: f64,
    pub cfl: f64,
    pub adaptive: bool,
    /* private fields */
}

A solver which implements the algorithm described in NRPyElliptic. This transforms the elliptic equation 𝓛{u} = p, into the hyperbolic equation ∂ₜ²u + η∂ₜu = c² (𝓛{u} - p), where c is the speed of the wave, and η is a dampening term that speeds up convergence.

Fields

tolerance: f64

Error tolerance (relaxation stops once error goes below this value).

max_steps: usize

Maximum number of relaxation steps to perform

dampening: f64

Dampening term η.

cfl: f64

CFL factor for ficticuous time step.

adaptive: bool

If set, the relax solver uses larger time steps for vertices in less refined regions (subject to the CFL condition of course).

Implementations

impl HyperRelaxSolver

pub fn new() -> Self

Constructs a new HyperRelaxSolver with default settings.

pub fn solve<const N: usize, C: SystemBoundaryConds<N> + Sync, F: Function<N> + Sync>( &mut self, mesh: &mut Mesh<N>, order: usize, conditions: C, deriv: F, result: ImageMut<'_>, ) -> Result<(), HyperRelaxError<F::Error, Infallible>>

where F::Error: Send,

Solves a given elliptic system

pub fn solve_with_callback<const N: usize, C: SystemBoundaryConds<N> + Sync, F: Function<N> + Sync, Call: SolverCallback<N>>( &mut self, mesh: &mut Mesh<N>, order: usize, conditions: C, callback: Call, deriv: F, result: ImageMut<'_>, ) -> Result<(), HyperRelaxError<F::Error, Call::Error>>

where F::Error: Send, Call::Error: Send,

Trait Implementations

impl Clone for HyperRelaxSolver

fn clone(&self) -> HyperRelaxSolver

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataSize for HyperRelaxSolver

const IS_DYNAMIC: bool

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

impl Debug for HyperRelaxSolver

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

Formats the value using the given formatter.

impl Default for HyperRelaxSolver

fn default() -> Self

Returns the “default value” for a type.