jaxincell._parameters

Submodules

Attributes

ALL_DOMAIN_PARAMETERS

DIFFERENTIABLE_DOMAIN_PARAMETERS

ALL_EXTERNAL_FIELD_PARAMETERS

DIFFERENTIABLE_EXTERNAL_FIELD_PARAMETERS

ALL_SOLVER_PARAMETERS

DIFFERENTIABLE_SOLVER_PARAMETERS

ALL_SOURCE_PARAMETERS

DIFFERENTIABLE_SOURCE_PARAMETERS

ALL_ION_PARAMETERS

ALL_ELECTRON_PARAMETERS

ALL_SPECIES_PARAMETERS

SPECIES_TYPES

SPECIES_AXES

SPECIES_DEFAULT_LABELS

SPECIES_CANONICAL_PREFIXES

SPECIES_PARAMETER_KEYS

SPECIES_DIFFERENTIABLE_KEYS

DIFFERENTIABLE_ION_PARAMETERS

DIFFERENTIABLE_ELECTRON_PARAMETERS

DIFFERENTIABLE_SPECIES_PARAMETERS

SPECIES_DEFAULT_PARAMETERS

SPECIES_INITIAL_DEFAULT_PARAMETERS

DEFAULT_INITIAL_ION_PARAMETERS

DEFAULT_INITIAL_ELECTRON_PARAMETERS

DEFAULT_ION_PARAMETERS

DEFAULT_ELECTRON_PARAMETERS

PARAMETER_SECTIONS

PARAMETER_SECTION_KEYS

FLAT_DIFFERENTIABLE_INPUT_PARAMETERS

DIFFERENTIABLE_INPUT_PARAMETERS

Functions

clean_and_initialize_domain_parameters(domain_parameters)

build_domain_hash(domain_parameters)

clean_and_initialize_external_field_parameters(...[, ...])

build_external_field_hash(external_field_parameters)

clean_and_initialize_solver_parameters(solver_parameters)

build_solver_hash(solver_parameters)

clean_and_initialize_source_parameters(source_parameters)

build_source_hash(source_parameters)

clean_and_initialize_species_parameters(species_parameters)

coerce_species_initial_phase_space_parameters(species, ...)

resolve_species_references(species_parameters)

build_species_hash(species_parameters)

Package Contents

jaxincell._parameters.ALL_DOMAIN_PARAMETERS = ['total_steps', 'timestep_over_spatialstep_times_c', 'number_grid_points',...
jaxincell._parameters.DIFFERENTIABLE_DOMAIN_PARAMETERS = ['timestep_over_spatialstep_times_c', 'length', 'length_y', 'length_z']
jaxincell._parameters.clean_and_initialize_domain_parameters(domain_parameters, input_parameters=None)
jaxincell._parameters.build_domain_hash(domain_parameters)
jaxincell._parameters.ALL_EXTERNAL_FIELD_PARAMETERS = ['external_electric_field_amplitude', 'external_electric_field_wavenumber',...
jaxincell._parameters.DIFFERENTIABLE_EXTERNAL_FIELD_PARAMETERS = []
jaxincell._parameters.clean_and_initialize_external_field_parameters(external_field_parameters, input_parameters=None)
jaxincell._parameters.build_external_field_hash(external_field_parameters)
jaxincell._parameters.ALL_SOLVER_PARAMETERS = ['print_info', 'field_solver', 'relativistic', 'time_evolution_algorithm',...
jaxincell._parameters.DIFFERENTIABLE_SOLVER_PARAMETERS = ['filter_alpha']
jaxincell._parameters.clean_and_initialize_solver_parameters(solver_parameters, input_parameters=None)
jaxincell._parameters.build_solver_hash(solver_parameters)
jaxincell._parameters.ALL_SOURCE_PARAMETERS = ['source_term_active', 'source_species', 'how_often_source_should_produce_quasiparticles',...
jaxincell._parameters.DIFFERENTIABLE_SOURCE_PARAMETERS = []
jaxincell._parameters.clean_and_initialize_source_parameters(source_parameters, input_parameters=None)
jaxincell._parameters.build_source_hash(source_parameters)
jaxincell._parameters.ALL_ION_PARAMETERS = ['number_pseudoparticles', 'grid_points_per_Debye_length', 'weight', 'perturbation_amplitude_x',...
jaxincell._parameters.ALL_ELECTRON_PARAMETERS = ['number_pseudoparticles', 'grid_points_per_Debye_length', 'weight', 'perturbation_amplitude_x',...
jaxincell._parameters.ALL_SPECIES_PARAMETERS = ['number_pseudoparticles', 'grid_points_per_Debye_length', 'weight', 'perturbation_amplitude_x',...
jaxincell._parameters.SPECIES_TYPES = ('electrons', 'ions')
jaxincell._parameters.SPECIES_AXES = ('x', 'y', 'z')
jaxincell._parameters.SPECIES_DEFAULT_LABELS
jaxincell._parameters.SPECIES_CANONICAL_PREFIXES
jaxincell._parameters.SPECIES_PARAMETER_KEYS
jaxincell._parameters.SPECIES_DIFFERENTIABLE_KEYS
jaxincell._parameters.DIFFERENTIABLE_ION_PARAMETERS = ['grid_points_per_Debye_length', 'weight', 'charge_over_elementary_charge',...
jaxincell._parameters.DIFFERENTIABLE_ELECTRON_PARAMETERS = ['grid_points_per_Debye_length', 'weight', 'charge_over_elementary_charge',...
jaxincell._parameters.DIFFERENTIABLE_SPECIES_PARAMETERS = ['grid_points_per_Debye_length', 'weight', 'charge_over_elementary_charge',...
jaxincell._parameters.SPECIES_DEFAULT_PARAMETERS
jaxincell._parameters.SPECIES_INITIAL_DEFAULT_PARAMETERS
jaxincell._parameters.DEFAULT_INITIAL_ION_PARAMETERS
jaxincell._parameters.DEFAULT_INITIAL_ELECTRON_PARAMETERS
jaxincell._parameters.DEFAULT_ION_PARAMETERS
jaxincell._parameters.DEFAULT_ELECTRON_PARAMETERS
jaxincell._parameters.clean_and_initialize_species_parameters(species_parameters, input_parameters=None)
jaxincell._parameters.coerce_species_initial_phase_space_parameters(species, species_label)
jaxincell._parameters.resolve_species_references(species_parameters)
jaxincell._parameters.build_species_hash(species_parameters)
jaxincell._parameters.PARAMETER_SECTIONS
jaxincell._parameters.PARAMETER_SECTION_KEYS
jaxincell._parameters.FLAT_DIFFERENTIABLE_INPUT_PARAMETERS = []
jaxincell._parameters.DIFFERENTIABLE_INPUT_PARAMETERS = []