m_user_methods Module Reference

This module contains all the methods that users can customize. More...

Data Types
interface	bool_subr
interface	field_func
interface	gas_dens_func
interface	generic_subr
interface	log_subr
interface	log_vars

Variables
procedure(af_subr_ref), pointer	user_refine => null()
	User-defined refinement routine.
procedure(af_subr), pointer	user_initial_conditions => null()
	If defined, call this routine after setting initial conditions.
procedure(af_subr), pointer	user_new_pulse_conditions => null()
	If defined, call this routine after a new voltage pulse starts.
procedure(af_subr_bc), pointer	user_potential_bc => null()
	To set custom boundary conditions for the electric potential.
procedure(gas_dens_func), pointer	user_gas_density => null()
	To set a user-defined gas number density.
procedure(field_func), pointer	user_field_amplitude => null()
	To set the field amplitude manually.
procedure(generic_subr), pointer	user_generic_method => null()
	Generic procedure that is called every time step.
procedure(log_subr), pointer	user_write_log => null()
	To write a custom log file.
procedure(log_vars), pointer	user_log_variables => null()
	To add entries to the log file.
procedure(mg_func_lsf), pointer	user_lsf => null()
	Custom level-set function to define an electrode.
procedure(mg_func_lsf), pointer	user_lsf_bc => null()
	Function to get boundary value for level set function.
integer, parameter	user_max_log_vars = 20

Detailed Description

This module contains all the methods that users can customize.

Variable Documentation

user_field_amplitude

procedure(field_func), pointer m_user_methods::user_field_amplitude => null()

To set the field amplitude manually.

Definition at line 27 of file m_user_methods.f90.

user_gas_density

procedure(gas_dens_func), pointer m_user_methods::user_gas_density => null()

To set a user-defined gas number density.

Definition at line 24 of file m_user_methods.f90.

user_generic_method

procedure(generic_subr), pointer m_user_methods::user_generic_method => null()

Generic procedure that is called every time step.

Definition at line 30 of file m_user_methods.f90.

user_initial_conditions

procedure(af_subr), pointer m_user_methods::user_initial_conditions => null()

If defined, call this routine after setting initial conditions.

Definition at line 15 of file m_user_methods.f90.

user_log_variables

procedure(log_vars), pointer m_user_methods::user_log_variables => null()

To add entries to the log file.

Definition at line 36 of file m_user_methods.f90.

user_lsf

procedure(mg_func_lsf), pointer m_user_methods::user_lsf => null()

Custom level-set function to define an electrode.

Definition at line 39 of file m_user_methods.f90.

user_lsf_bc

procedure(mg_func_lsf), pointer m_user_methods::user_lsf_bc => null()

Function to get boundary value for level set function.

[method_list]

Definition at line 42 of file m_user_methods.f90.

user_max_log_vars

integer, parameter m_user_methods::user_max_log_vars = 20

Definition at line 45 of file m_user_methods.f90.

user_new_pulse_conditions

procedure(af_subr), pointer m_user_methods::user_new_pulse_conditions => null()

If defined, call this routine after a new voltage pulse starts.

Definition at line 18 of file m_user_methods.f90.

user_potential_bc

procedure(af_subr_bc), pointer m_user_methods::user_potential_bc => null()

To set custom boundary conditions for the electric potential.

Definition at line 21 of file m_user_methods.f90.

user_refine

procedure(af_subr_ref), pointer m_user_methods::user_refine => null()

User-defined refinement routine.

Definition at line 12 of file m_user_methods.f90.

user_write_log

procedure(log_subr), pointer m_user_methods::user_write_log => null()

To write a custom log file.

Definition at line 33 of file m_user_methods.f90.