Skip to content

vSmartMOM Module Methods & Types ​

Defining Parameters for RT Simulation ​

Use read_parameters as the general loader for YAML/TOML files, in-memory dictionaries, and typed IO sources. Use default_parameters for the built-in default scene.

The explicit helpers parameters_from_file, parameters_from_dict, parameters_from_source, and parameters_from_yaml are also available when a call site should state the input kind directly.

Using the Parameters Object to Create a Model ​

Use model_from_parameters(params) to construct an RTModel from a parsed scene. See the Library for the canonical docstring and return-shape details.

Performing the RT Simulation ​

Use rt_run(model) for the forward solver. Linearized runs use model_from_parameters_lin and rt_run_lin; see Compute Jacobians.

Types ​

Parameters Type ​

CoreRT.vSmartMOM_Parameters is the parsed scene container returned by read_parameters, parameters_from_file, and related loader helpers.

Model Type ​

RTModel is the hierarchical model state used by the solver. New code should prefer the solver, geometry, quad_points, atmosphere, optics, and surfaces fields over legacy flat-field access.

Surface Types ​

Surface models are subtypes of CoreRT.AbstractSurfaceType. The public surface set includes Lambertian scalar/spectrum/Legendre/spline forms, RPV, Ross-Li, Cox-Munk ocean, and canopy surfaces. See Surfaces and Add a Surface BRDF for configuration and extension guidance.

vSmartMOM.CoreRT.invalidate_canopy_cache! Function
julia
invalidate_canopy_cache!(canopy::CanopySurface)

Force recomputation of the canopy cache on the next create_surface_layer! call. Use after changing canopy parameters (LAI, LAD, etc.) between runs.

source

Quadrature Types ​

vSmartMOM.CoreRT.AbstractQuadratureType Type

Quadrature Types for RT streams

source
vSmartMOM.CoreRT.RadauQuad Type
julia
struct RadauQuad

Use Gauss Radau quadrature scheme, which includes the SZA as point (see Sanghavi vSmartMOM)

source
vSmartMOM.CoreRT.GaussLegQuad Type
julia
struct GaussLegQuad

Half-space Gauss-Legendre quadrature on [0, 1] for the upper hemisphere. The default for plane-parallel RT.

source

Atmospheric Profile Type ​

CoreRT.AtmosphericProfile stores the layer temperature, pressure, humidity, column-density, and gas-mixing-ratio fields consumed by model_from_parameters.