Stellarator-Tools
siesta_context Module Reference

Defines the base class of the type siesta_context_class. This contains the state variables needed by SIESTA. More...

Data Types

type  siesta_context_class
 Base class representing a siesta_context. This contains a copy of every variable that is needed to define the SIESTA state. More...
 

Functions/Subroutines

class(siesta_context_class) function, pointer siesta_context_construct (restart_file_name)
 Construct a siesta_context_class object. More...
 
subroutine siesta_context_destruct (this)
 Deconstruct a siesta_context_class object. More...
 
subroutine siesta_context_read (this, restart_file_name)
 Read a restart file. More...
 

Detailed Description

Defines the base class of the type siesta_context_class. This contains the state variables needed by SIESTA.

Function/Subroutine Documentation

◆ siesta_context_construct()

class (siesta_context_class) function, pointer siesta_context::siesta_context_construct ( character (len=*), intent(in)  restart_file_name)

Construct a siesta_context_class object.

Allocates memory and initializes a siesta_context_class object.

Parameters
[in]restart_file_nameFilename of the SIESTA restart file.
Returns
A pointer to a constructed siesta_context_class object.

◆ siesta_context_destruct()

subroutine siesta_context::siesta_context_destruct ( type (siesta_context_class), intent(inout)  this)

Deconstruct a siesta_context_class object.

Deallocates memory and uninitializes a siesta_context_class object.

Parameters
[in,out]thisA siesta_context_class instance.

◆ siesta_context_read()

subroutine siesta_context::siesta_context_read ( class (siesta_context_class), intent(inout)  this,
character (len=*), intent(in)  restart_file_name 
)

Read a restart file.

Loads values from a new restart file.

Parameters
[in,out]thisA siesta_context_class instance.
[in]restart_file_nameFilename of the SIESTA restart file.