particles_params_read Subroutine

public subroutine particles_params_read(files)

Uses

  • proc~~particles_params_read~~UsesGraph proc~particles_params_read particles_params_read module~mod_global_parameters mod_global_parameters proc~particles_params_read->module~mod_global_parameters module~mod_basic_types mod_basic_types module~mod_global_parameters->module~mod_basic_types module~mod_connectivity mod_connectivity module~mod_global_parameters->module~mod_connectivity module~mod_constants mod_constants module~mod_global_parameters->module~mod_constants module~mod_physicaldata mod_physicaldata module~mod_global_parameters->module~mod_physicaldata module~mod_variables mod_variables module~mod_global_parameters->module~mod_variables mpi mpi module~mod_global_parameters->mpi module~mod_variables->module~mod_basic_types

Read this module's parameters from a file

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: files(:)

Called by

proc~~particles_params_read~~CalledByGraph proc~particles_params_read particles_params_read proc~particle_base_init particle_base_init proc~particle_base_init->proc~particles_params_read proc~particles_init particles_init proc~particles_init->proc~particle_base_init

Namelists

Namelist particles_list


Variables

Name Type Default Description
physics_type_particles character(len=name_len) ""

String describing the particle physics type
nparticleshi integer None

Maximum number of particles
nparticles_per_cpu_hi integer None

Maximum number of particles in one processor
write_individual logical None

Whether to write individual particle output (followed particles)
write_ensemble logical None

Whether to write ensemble output
write_snapshot logical None

Whether to write particle snapshots
downsample_particles integer None

Particle downsampling factor in CSV output
dtsave_particles double precision None

Time interval to save particles
tmax_particles double precision None

Time limit of particles
num_particles integer None

Number of particles
ndefpayload integer None

Number of default payload variables for a particle
nusrpayload integer None

Number of user-defined payload variables for a particle
losses logical None
const_dt_particles double precision None

If positive, a constant time step for the particles
particles_cfl double precision None

Particle CFL safety factor
dtheta double precision None
relativistic logical None

Use a relativistic particle mover?
integrator_type_particles character(len=name_len) ""

String describing the particle integrator type
particles_eta double precision None

Resistivity
particles_etah double precision None

Resistivity

Source Code

  subroutine particles_params_read(files)
    use mod_global_parameters, only: unitpar
    character(len=*), intent(in) :: files(:)
    integer                      :: n

    namelist /particles_list/ physics_type_particles, nparticleshi,&
        nparticles_per_cpu_hi, write_individual, write_ensemble,&
        write_snapshot, downsample_particles, dtsave_particles, tmax_particles,&
        num_particles, ndefpayload, nusrpayload, losses, const_dt_particles,&
        particles_cfl, dtheta, relativistic, integrator_type_particles,&
        particles_eta, particles_etah

    do n = 1, size(files)
      open(unitpar, file=trim(files(n)), status="old")
      read(unitpar, particles_list, end=111)
111   close(unitpar)
    end do

  end subroutine particles_params_read