Struct kalast::core::body::Properties

pub struct Properties { /* fields omitted */ }

Ground properties of celestial bodies

Definition

Properties are initialized

Example

use kalast::{Properties, HOUR};

let properties = Properties::new(
    11.92 * HOUR, // rotation period
    11.92 * HOUR, // revolution period
    0.,           // obliquity
    500.,         // thermal inertia
    2146.,        // density
    600.,         // heat capacity
    0.07,         // albedo
    0.9,          // emissivity
);

Implementations

impl Properties

pub fn new(
    rotation_period: f64,
    revolution_period: f64,
    obliquity: f64,
    thermal_inertia: f64,
    density: f64,
    heat_capacity: f64,
    albedo: f64,
    emissivity: f64
) -> Self

Basic properties constructor.

pub fn rotation_period(&self) -> f64

Rotation period getter.

pub fn revolution_period(&self) -> f64

Revolution period getter.

pub fn obliquity(&self) -> f64

Obliquity getter.

pub fn thermal_inertia(&self) -> f64

Thermal inertia getter.

pub fn density(&self) -> f64

Density getter.

pub fn heat_capacity(&self) -> f64

Heat capacity getter.

pub fn albedo(&self) -> f64

Albedo getter.

pub fn emissivity(&self) -> f64

Emissivity getter.

pub fn number_thermal_skin_depth(&self) -> usize

Number of thermal skin depth getter.

pub fn set_number_thermal_skin_depth(
    &mut self,
    number_thermal_skin_depth: usize
)

Number of thermal skin depth setter.

pub fn time_step(&self) -> f64

Time step getter. Fails if the time step of the simulation has not been shared with this struct.

pub fn set_time_step(&mut self, time_step: f64) -> bool

Time step setter. Return true if the time step has been modified, else false.

pub fn compute_properties(&mut self)

Compute properties not initialized.

pub fn conductivity(&self) -> f64

Conductivity getter.

pub fn compute_conductivity(&mut self)

Compute conductivity.

pub fn diffusivity(&self) -> f64

Diffusivity getter.

pub fn compute_diffusivity(&mut self)

Compute diffusivity.

pub fn thermal_skin_depth(&self) -> f64

Thermal skin depth getter.

pub fn compute_thermal_skin_depth(&mut self)

Compute thermal skin depth.

pub fn ground_depth(&self) -> f64

Ground depth getter.

pub fn set_ground_depth(&mut self, ground_depth: f64)

Ground depth setter.

pub fn compute_ground_depth(&mut self)

Compute depth memoized.

pub fn ground_step(&self) -> f64

Ground step getter.

pub fn compute_ground_step(&mut self)

Compute ground step.

pub fn set_ground_step(&mut self, ground_step: f64)

Ground step setter.

pub fn ground_vector(&self) -> &VX<f64>

Ground vector getter as reference.

pub fn recompute_ground_vector(&mut self)

Force ground vector recomputation.

pub fn compute_ground_vector(&mut self)

Compute ground vector. Initialize to be at least the surface if no ground step or depth are set already.

pub fn diffusivity_field(&self) -> &f64

Diffusivity field getter.

pub fn compute_diffusivity_field(&mut self)

Compute diffusivity field.

pub fn rotation_axis(&self) -> &Unit<V3<f64>>

Rotation axis getter as reference.

pub fn compute_rotation_axis(&mut self)

Compute rotation axis.

pub fn rotation_angle(&self) -> f64

Rotation angle getter.

pub fn compute_rotation_angle(&mut self)

Compute rotation angle.

pub fn rotation_matrix(&self) -> &Rotation3<f64>

Rotation matrix getter as reference.

pub fn compute_rotation_matrix(&mut self)

Compute rotation matrix.

pub fn obliquity_initiation_axis(&self) -> &Unit<V3<f64>>

Obliquity initiation axis getter as reference.

pub fn compute_obliquity_initiation_axis(&mut self)

Compute obliquity initiation axis.

pub fn obliquity_initiation_rotation_matrix(&self) -> &Rotation3<f64>

Obliquity initiation rotation matrix getter as reference.

pub fn compute_obliquity_initiation_rotation_matrix(&mut self)

Compute obliquity initiation rotation matrix.

Trait Implementations

impl Clone for Properties

fn clone(&self) -> Properties

Returns a copy of the value.

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

Performs copy-assignment from source.