ashdisperse.params package

Submodules

ashdisperse.params.grain_params module

Grain parameters for AshDisperse.

Defines the GrainParameters class, containing attributes specifying grains classes and methods for amending these, and a printer for this object.

Example:

grains = GrainParameters() grains.add_grains(1e-4,1400,0.5) grains.add_grains(1e-3,1400,0.5)

print_grain_parameters(grains)

class ashdisperse.params.grain_params.GrainParameters(*args, **kwargs)

Bases: GrainParameters

Grain parameters required for AshDisperse.

Defines the GrainParameters class, containing attributes specifying grains classes and methods for amending these.

Attributes:: bins: An integer count of the number of grain classes. diameter: A list of floats containing the diameter of each grain class. density: A list of floats containing the density of each grain class. proportion: A list of floats containing the proportion of each grain

class.

class_type = jitclass.GrainParameters#70c15b332cc0<bins:int64,diameter:ListType[float64],density:ListType[float64],proportion:ListType[float64]>

ashdisperse.params.met_params module

class ashdisperse.params.met_params.MetParameters(*args, **kwargs)

Bases: MetParameters

class_type = jitclass.MetParameters#70c15c460ce0<U_scale:float64,Ws_scale:array(float64, 1d, A)>

ashdisperse.params.model_params module

class ashdisperse.params.model_params.ModelParameters(*args, **kwargs)

Bases: ModelParameters

class_type = jitclass.ModelParameters#70c15b34d100<SettlingScale:ListType[float64],Velocity_ratio:ListType[float64],xScale:ListType[float64],yScale:ListType[float64],Lx:ListType[float64],Ly:ListType[float64],cScale:ListType[float64],QScale:ListType[float64],Peclet_number:float64,Diffusion_ratio:float64,sigma_hat:ListType[float64],sigma_hat_scale:ListType[float64]>

ashdisperse.params.output_params module

class ashdisperse.params.output_params.OutputParameters(*args, **kwargs)

Bases: OutputParameters

class_type = jitclass.OutputParameters#70c15b34e7e0<start:float64,stop:float64,step:float64,altitudes:array(float64, 1d, C),Nz:int64,Cheb_lower:array(complex128, 2d, C),Cheb_upper:array(complex128, 2d, C)>

ashdisperse.params.params module

class ashdisperse.params.params.Parameters(*args, **kwargs)

Bases: Parameters

class_type = jitclass.Parameters#70c15ac1d370<solver:OptionalType(instance.jitclass.SolverParameters#70c15a19a210<domX:float64,domY:float64,minN_log2:int64,maxN_log2:int64,Nx_log2:int64,Ny_log2:int64,epsilon:float64,plateau_factor:float64,fft_tol:float64,meps:float64>),grains:OptionalType(instance.jitclass.GrainParameters#70c15b332cc0<bins:int64,diameter:ListType[float64],density:ListType[float64],proportion:ListType[float64]>),emission:OptionalType(instance.jitclass.EmissionParameters#70c15bf96f00<lower:ListType[float64],upper:ListType[float64],profile:ListType[int64],Suzuki_k:ListType[float64]>),source:OptionalType(instance.jitclass.SourceParameters#70c15a19bd10<latitude:float64,longitude:float64,utmcode:int64,radius:float64,PlumeHeight:float64,MER:float64,duration:float64,name:unicode_type>),physical:OptionalType(instance.jitclass.PhysicalParameters#70c15b07e240<Kappa_h:float64,Kappa_v:float64,g:float64,mu:float64>),met:OptionalType(instance.jitclass.MetParameters#70c15c460ce0<U_scale:float64,Ws_scale:array(float64, 1d, A)>),model:OptionalType(instance.jitclass.ModelParameters#70c15b34d100<SettlingScale:ListType[float64],Velocity_ratio:ListType[float64],xScale:ListType[float64],yScale:ListType[float64],Lx:ListType[float64],Ly:ListType[float64],cScale:ListType[float64],QScale:ListType[float64],Peclet_number:float64,Diffusion_ratio:float64,sigma_hat:ListType[float64],sigma_hat_scale:ListType[float64]>),output:OptionalType(instance.jitclass.OutputParameters#70c15b34e7e0<start:float64,stop:float64,step:float64,altitudes:array(float64, 1d, C),Nz:int64,Cheb_lower:array(complex128, 2d, C),Cheb_upper:array(complex128, 2d, C)>)>

ashdisperse.params.params.copy_parameters(A)

ashdisperse.params.params.load_parameters(file)

ashdisperse.params.params.parameters_from_dict(paramset: dict) → Parameters

ashdisperse.params.params.save_parameters(params, file='parameters.toml')

ashdisperse.params.params.update_parameters(A, name=None, domX=None, domY=None, minN_log2=None, maxN_log2=None, epsilon=None, plateau_factor=None, fft_tol=None, Nx_log2=None, Ny_log2=None, grains=None, emissions: list[dict[str, int | float]] | str | None = None, latitude=None, longitude=None, radius=None, PlumeHeight=None, MER=None, duration=None, Kappa_h=None, Kappa_v=None, g=None, mu=None, start=None, stop=None, step=None)

ashdisperse.params.physical_params module

class ashdisperse.params.physical_params.PhysicalParameters(*args, **kwargs)

Bases: PhysicalParameters

class_type = jitclass.PhysicalParameters#70c15b07e240<Kappa_h:float64,Kappa_v:float64,g:float64,mu:float64>

ashdisperse.params.solver_params module

class ashdisperse.params.solver_params.SolverParameters(*args, **kwargs)

Bases: SolverParameters

class_type = jitclass.SolverParameters#70c15a19a210<domX:float64,domY:float64,minN_log2:int64,maxN_log2:int64,Nx_log2:int64,Ny_log2:int64,epsilon:float64,plateau_factor:float64,fft_tol:float64,meps:float64>

ashdisperse.params.source_params module

class ashdisperse.params.source_params.SourceParameters(*args, **kwargs)

Bases: SourceParameters

class_type = jitclass.SourceParameters#70c15a19bd10<latitude:float64,longitude:float64,utmcode:int64,radius:float64,PlumeHeight:float64,MER:float64,duration:float64,name:unicode_type>