V3FIT
Functions/Subroutines | Variables
siesta_state Module Reference

This file contains subroutines for aupdating from t to t + delta_t the magnetic field and pressure as part of the SIESTA project. Stores updated values of JPMN*H, JBSUBXMN*H in Quantities Module. More...

Functions/Subroutines

subroutine update_state (lprint, fsq_total, ftol)
 Update the SIESTA state. More...
 
subroutine updatefields (jbsupsmnh, jbsupumnh, jbsupvmnh, jpmnh,
 Update the magentic and pressure for the current SIESTA state. More...
 
subroutine update_diagnostics (jbsupsmnh, jbsupumnh, jbsupvmnh,
 Write SIESTA diagnostic (screen) output per iteration. More...
 
subroutine clear_field_perts
 Reset the perturbations of the SIESTA state.
 

Variables

logical, public lfirst = .true.
 Flag to indicate that this was the first run.
 

Detailed Description

This file contains subroutines for aupdating from t to t + delta_t the magnetic field and pressure as part of the SIESTA project. Stores updated values of JPMN*H, JBSUBXMN*H in Quantities Module.

Function/Subroutine Documentation

◆ update_diagnostics()

subroutine siesta_state::update_diagnostics (   jbsupsmnh,
  jbsupumnh,
  jbsupvmnh 
)

Write SIESTA diagnostic (screen) output per iteration.

Parameters
[in]jbsupsmnhContravariant magnetic field in the s direction.
[in]jbsupumnhContravariant magnetic field in the u direction.
[in]jbsupvmnhContravariant magnetic field in the v direction.
[in]jpmnhPressure Fourier coeffients.
[out]bsFIXME: UNKNOWN
[out]buFIXME: UNKNOWN
[out]bsbu_ratioFIXME: UNKNOWN
[in,out]pwr_specFIXME: UNKNOWN
[in]iparityFourier parity.

Definition at line 204 of file siesta_state.f90.

◆ update_state()

subroutine siesta_state::update_state ( logical, intent(in)  lprint,
real (dp), intent(in)  fsq_total,
real (dp), intent(in)  ftol 
)

Update the SIESTA state.

Adds the perturbation to the field. This is called before taking the next step.

Parameters
[in]lprintControls screen output.
[in]fsq_totalTotal force residual.
[in]ftolForce residual tolarance.

Definition at line 51 of file siesta_state.f90.

◆ updatefields()

subroutine siesta_state::updatefields (   jbsupsmnh,
  jbsupumnh,
  jbsupvmnh,
real (dp), dimension(:,:,:), intent(inout), allocatable  jpmnh 
)

Update the magentic and pressure for the current SIESTA state.

Parameters
[in,out]jbsupsmnhContravariant magnetic field in the s direction.
[in,out]jbsupumnhContravariant magnetic field in the u direction.
[in,out]jbsupvmnhContravariant magnetic field in the v direction.
[in,out]jpmnhPressure Fourier coeffients.
[in,out]djbsupsmnhContravariant magnetic field perturbation in the s direction.
[in,out]djbsupumnhContravariant magnetic field perturbation in the u direction.
[in,out]djbsupvmnhContravariant magnetic field perturbation in the v direction.
[in,out]djpmnhPressure perturbation.

Definition at line 161 of file siesta_state.f90.