Struct BoutGrid

Source

pub struct BoutGrid {Show 13 fields
    pub nx: usize,
    pub ny: usize,
    pub r_grid: Array2<f64>,
    pub z_grid: Array2<f64>,
    pub psi_n: Array2<f64>,
    pub b_mag: Array2<f64>,
    pub g_xx: Array2<f64>,
    pub g_yy: Array2<f64>,
    pub g_zz: Array2<f64>,
    pub g_xy: Array2<f64>,
    pub jacobian: Array2<f64>,
    pub q_profile: Vec<f64>,
    pub b_toroidal: f64,
}

Expand description

BOUT++ field-aligned grid with metric tensors.

Fields§

§nx: usize

Number of radial points.

§ny: usize

Number of poloidal points.

§r_grid: Array2<f64>

R coordinates on the grid [nx × ny].

§z_grid: Array2<f64>

Z coordinates on the grid [nx × ny].

§psi_n: Array2<f64>

Normalised poloidal flux ψ_N on the grid [nx × ny].

§b_mag: Array2<f64>

Magnetic field magnitude |B| [T] on the grid [nx × ny].

§g_xx: Array2<f64>

Contravariant metric g^{xx} (radial-radial) [nx × ny].

§g_yy: Array2<f64>

Contravariant metric g^{yy} (poloidal-poloidal) [nx × ny].

§g_zz: Array2<f64>

Contravariant metric g^{zz} (toroidal-toroidal) [nx × ny].

§g_xy: Array2<f64>

Contravariant metric g^{xy} (radial-poloidal) [nx × ny].

§jacobian: Array2<f64>

Jacobian J [nx × ny].

§q_profile: Vec<f64>

Safety factor q(ψ) [nx].

§b_toroidal: f64

Toroidal field B_toroidal [T].

Trait Implementations§

Source §

impl Clone for BoutGrid

Source §

fn clone(&self) -> BoutGrid

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for BoutGrid

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for BoutGrid

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§