Stellarator-Tools
siesta_run::siesta_run_class Interface Reference

Interface for the siesta_run constructor. More...

Public Member Functions

PROCEDURE set_vmec_ => siesta_run_set_vmec
 
PROCEDURE set_vmec_temp => siesta_run_set_vmec_temp
 
GENERIC set_vmec => set_vmec_, set_vmec_temp
 
PROCEDURE set_restart => siesta_run_set_restart
 
PROCEDURE set_1d => siesta_run_set_1d
 
GENERIC set => set_1d
 
PROCEDURE converge => siesta_run_converge
 
PROCEDURE sync => siesta_run_sync
 
FINAL siesta_run_destruct
 
class(siesta_run_class) function, pointer siesta_run_construct (run_comm, verbose, init_mpi, close_w
 Construct new siesta_run_class object. More...
 

Public Attributes

real(dp) time_on
 Timer On.
 
integer control_state
 Control state.
 

Detailed Description

Interface for the siesta_run constructor.

Member Function/Subroutine Documentation

◆ siesta_run_construct()

class (siesta_run_class) function, pointer siesta_run::siesta_run_class::siesta_run_construct ( integer, intent(in)  run_comm,
logical, intent(in)  verbose,
logical, intent(in)  init_mpi,
  close_w 
)

Construct new siesta_run_class object.

Allocates memory and initializes a siesta_run_class object. Performs all the initialization needed to operate SIESTA.

Parameters
[in]run_commMPI Communicator to use.
[in]verboseControl the code screen output.
[in]init_mpiInstructs if MPI should be initialized.
[in]close_woutInstructs if wout file should be closed on deallocate.
[in]namelist_filePath to the siesta namelist input file.
Returns
A pointer to a constructed siesta_run_class object.

The documentation for this interface was generated from the following file: