mod_hall_settings Module

Uses

- mod_global_variables

Derived Types

type, public :: hall_settings_t

Components

Type	Visibility	Attributes		Name		Initial
logical,	private		::	has_hall
logical,	private		::	use_hall_substitution
logical,	private		::	electron_inertia
real(kind=dp),	private		::	electron_fraction
logical,	public		::	use_dropoff
logical,	public		::	use_inertia_dropoff

Type-Bound Procedures

procedure, public :: enable
procedure, public :: enable_electron_inertia
procedure, public :: disable
procedure, public :: is_enabled
procedure, public :: is_using_substitution
procedure, public :: has_electron_inertia
procedure, public :: set_electron_fraction
procedure, public :: get_electron_fraction

Functions

public pure function new_hall_settings() result(hall)

Arguments

None

Return Value type(hall_settings_t)

private pure function is_enabled(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(hall_settings_t),	intent(in)			::	this

Return Value logical

private pure function is_using_substitution(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(hall_settings_t),	intent(in)			::	this

Return Value logical

private pure function has_electron_inertia(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(hall_settings_t),	intent(in)			::	this

Return Value logical

private pure function get_electron_fraction(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(hall_settings_t),	intent(in)			::	this

Return Value real(kind=dp)

Subroutines

private pure subroutine enable(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(hall_settings_t),	intent(inout)			::	this

private pure subroutine enable_electron_inertia(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(hall_settings_t),	intent(inout)			::	this

private pure subroutine disable(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(hall_settings_t),	intent(inout)			::	this

private pure subroutine set_electron_fraction(this, electron_fraction)

Arguments

Type	Intent	Optional	Attributes		Name
class(hall_settings_t),	intent(inout)			::	this
real(kind=dp),	intent(in)			::	electron_fraction