mhd3d_minimize.F90 Source File

!!matvec with matmul !#define __MATVEC_N(y,Mat,Vec) y=MATMUL(Mat,Vec) !#define __MATVEC_T(y,Mat,Vec) y=MATMUL(Vec,Mat) !#define __PMATVEC_N(fy,y,Mat,Vec) y=fyy+MATMUL(Mat,Vec) !#define __PMATVEC_T(fy,y,Mat,Vec) y=fyy+MATMUL(Vec,Mat) !#define __AMATVEC_N(y,fMat,Mat,Vec) y=fMatMATMUL(Mat,Vec) !#define __AMATVEC_T(y,fMat,Mat,Vec) y=fMatMATMUL(Vec,Mat) !#define __PAMATVEC_N(fy,y,fMat,Mat,Vec) y=fyy+fMatMATMUL(Mat,Vec) !#define __PAMATVEC_T(fy,y,fMat,Mat,Vec) y=fyy+fMatMATMUL(Vec,Mat)

!!#define __GENERICMATVEC(NT,fy,y,fMat,Mat,Vec) CALL DGEMV(NT,SIZE(Mat,1),SIZE(Mat,2),fMat,Mat,SIZE(Mat,1),Vec,1,fy,y,1)

!!matmat with matmul !#define __MATMAT_NN(Y,A,B) Y=MATMUL(A,B) !#define __MATMAT_TN(Y,A,B) Y=MATMUL(TRANSPOSE(A),B) !#define __MATMAT_NT(Y,A,B) Y=MATMUL(A,TRANSPOSE(B)) !#define __MATMAT_TT(Y,A,B) Y=TRANSPOSE(MATMUL(B,A))

!#define __PMATMAT_NN(fy,Y,A,B) Y=fyY+MATMUL(A,B) !#define __PMATMAT_TN(fy,Y,A,B) Y=fyY+MATMUL(TRANSPOSE(A),B) !#define __PMATMAT_NT(fy,Y,A,B) Y=fyY+MATMUL(A,TRANSPOSE(B)) !#define __PMATMAT_TT(fy,Y,A,B) Y=fyY+TRANSPOSE(MATMUL(B,A))

!#define __AMATMAT_NN(Y,fa,A,B) Y=faMATMUL(A,B) !#define __AMATMAT_TN(Y,fa,A,B) Y=faMATMUL(TRANSPOSE(A),B) !#define __AMATMAT_NT(Y,fa,A,B) Y=faMATMUL(A,TRANSPOSE(B)) !#define __AMATMAT_TT(Y,fa,A,B) Y=faTRANSPOSE(MATMUL(B,A))

!#define __PAMATMAT_NN(fy,Y,fa,A,B) Y=fyY+faMATMUL(A,B) !#define __PAMATMAT_TN(fy,Y,fa,A,B) Y=fyY+faMATMUL(TRANSPOSE(A),B) !#define __PAMATMAT_NT(fy,Y,fa,A,B) Y=fyY+faMATMUL(A,TRANSPOSE(B)) !#define __PAMATMAT_TT(fy,Y,fa,A,B) Y=fyY+faTRANSPOSE(MATMUL(B,A))

! GEMM does in general Y = fa A^?B^? + fy Y ! with structure: (m x n) = (m x k) (k x n) ! Y=A B : DGEMM('N','N',m,n,k,fa,Amat ,m, Bmat,k, fy,Y,m) ! Y=A^TB : DGEMM('T','N',m,n,k,fa,Amat ,k, Bmat,k, fy,Y,m) ! Y=A B^T : DGEMM('N','T',m,n,k,fa,Amat ,m, Bmat,n, fy,Y,m) ! Y=A^T*B^T : DGEMM('T','T',m,n,k,fa,Amat ,k, Bmat,n, fy,Y,m)

!#define __GENERICMATMAT_NN(fy,Y,fa,A,B) CALL DGEMM('N','N',SIZE(A,1),SIZE(B,2),SIZE(B,1),fa,A,SIZE(A,1),B,SIZE(B,1),fy,Y,SIZE(A,1)) !#define __GENERICMATMAT_TN(fy,Y,fa,A,B) CALL DGEMM('T','N',SIZE(A,2),SIZE(B,2),SIZE(B,1),fa,A,SIZE(B,1),B,SIZE(B,1),fy,Y,SIZE(A,2)) !#define __GENERICMATMAT_NT(fy,Y,fa,A,B) CALL DGEMM('N','T',SIZE(A,1),SIZE(B,1),SIZE(B,2),fa,A,SIZE(A,1),B,SIZE(B,1),fy,Y,SIZE(A,1)) !#define __GENERICMATMAT_TT(fy,Y,fa,A,B) CALL DGEMM('T','T',SIZE(A,2),SIZE(B,1),SIZE(B,2),fa,A,SIZE(B,2),B,SIZE(B,1),fy,Y,SIZE(A,2))

! SIMPLE INTERFACE FOR DGEMM, specifying nrows/ncols of mat A and nrows/ncols of mat B (for any transpose!) ! GEMM does in general Y = fa A^?B^? + fy Y ! with structure: (m x n) = (m x k) (k x n) ! Y=A B : DGEMM('N','N',m,n,k,fa,Amat ,m, Bmat,k, fy,Y,m) ! Y=A^TB : DGEMM('T','N',m,n,k,fa,Amat ,k, Bmat,k, fy,Y,m) ! Y=A B^T : DGEMM('N','T',m,n,k,fa,Amat ,m, Bmat,n, fy,Y,m) ! Y=A^T*B^T : DGEMM('T','T',m,n,k,fa,Amat ,k, Bmat,n, fy,Y,m)


This file depends on

sourcefile~~mhd3d_minimize.f90~~EfferentGraph sourcefile~mhd3d_minimize.f90 mhd3d_minimize.F90 sourcefile~analyze.f90 analyze.F90 sourcefile~mhd3d_minimize.f90->sourcefile~analyze.f90 sourcefile~globals.f90 globals.F90 sourcefile~mhd3d_minimize.f90->sourcefile~globals.f90 sourcefile~mhd3d_evalfunc.f90 mhd3d_evalfunc.F90 sourcefile~mhd3d_minimize.f90->sourcefile~mhd3d_evalfunc.f90 sourcefile~output_vars.f90 output_vars.F90 sourcefile~mhd3d_minimize.f90->sourcefile~output_vars.f90 sourcefile~restart.f90 restart.F90 sourcefile~mhd3d_minimize.f90->sourcefile~restart.f90 sourcefile~sol_var_mhd3d.f90 sol_var_mhd3d.F90 sourcefile~mhd3d_minimize.f90->sourcefile~sol_var_mhd3d.f90 sourcefile~analyze.f90->sourcefile~globals.f90 sourcefile~analyze.f90->sourcefile~output_vars.f90 sourcefile~analyze.f90->sourcefile~sol_var_mhd3d.f90 sourcefile~analyze_vars.f90 analyze_vars.F90 sourcefile~analyze.f90->sourcefile~analyze_vars.f90 sourcefile~cubic_spline.f90 cubic_spline.F90 sourcefile~analyze.f90->sourcefile~cubic_spline.f90 sourcefile~mhd3d_vars.f90 mhd3d_vars.F90 sourcefile~analyze.f90->sourcefile~mhd3d_vars.f90 sourcefile~mod_mpi.f90 mod_mpi.F90 sourcefile~analyze.f90->sourcefile~mod_mpi.f90 sourcefile~output_csv.f90 output_csv.F90 sourcefile~analyze.f90->sourcefile~output_csv.f90 sourcefile~output_vtk.f90 output_vtk.F90 sourcefile~analyze.f90->sourcefile~output_vtk.f90 sourcefile~readintools.f90 readintools.F90 sourcefile~analyze.f90->sourcefile~readintools.f90 sourcefile~vmec.f90 vmec.F90 sourcefile~analyze.f90->sourcefile~vmec.f90 sourcefile~vmec_readin.f90 vmec_readin.F90 sourcefile~analyze.f90->sourcefile~vmec_readin.f90 sourcefile~vmec_vars.f90 vmec_vars.F90 sourcefile~analyze.f90->sourcefile~vmec_vars.f90 sourcefile~write_modes.f90 write_modes.F90 sourcefile~analyze.f90->sourcefile~write_modes.f90 sourcefile~mhd3d_evalfunc.f90->sourcefile~globals.f90 sourcefile~mhd3d_evalfunc.f90->sourcefile~sol_var_mhd3d.f90 sourcefile~base.f90 base.F90 sourcefile~mhd3d_evalfunc.f90->sourcefile~base.f90 sourcefile~mhd3d_evalfunc.f90->sourcefile~mhd3d_vars.f90 sourcefile~mhd3d_evalfunc.f90->sourcefile~mod_mpi.f90 sourcefile~sll_m_spline_matrix.f90 sll_m_spline_matrix.F90 sourcefile~mhd3d_evalfunc.f90->sourcefile~sll_m_spline_matrix.f90 sourcefile~sll_m_spline_matrix_banded.f90 sll_m_spline_matrix_banded.F90 sourcefile~mhd3d_evalfunc.f90->sourcefile~sll_m_spline_matrix_banded.f90 sourcefile~output_vars.f90->sourcefile~globals.f90 sourcefile~restart.f90->sourcefile~globals.f90 sourcefile~restart.f90->sourcefile~mhd3d_evalfunc.f90 sourcefile~restart.f90->sourcefile~output_vars.f90 sourcefile~restart.f90->sourcefile~sol_var_mhd3d.f90 sourcefile~restart.f90->sourcefile~base.f90 sourcefile~restart.f90->sourcefile~mhd3d_vars.f90 sourcefile~restart.f90->sourcefile~mod_mpi.f90 sourcefile~readstate.f90 readstate.F90 sourcefile~restart.f90->sourcefile~readstate.f90 sourcefile~readstate_vars.f90 readstate_vars.F90 sourcefile~restart.f90->sourcefile~readstate_vars.f90 sourcefile~restart_vars.f90 restart_vars.F90 sourcefile~restart.f90->sourcefile~restart_vars.f90 sourcefile~sgrid.f90 sgrid.F90 sourcefile~restart.f90->sourcefile~sgrid.f90 sourcefile~sol_var_mhd3d.f90->sourcefile~globals.f90 sourcefile~c_sol_var.f90 c_sol_var.F90 sourcefile~sol_var_mhd3d.f90->sourcefile~c_sol_var.f90 sourcefile~analyze_vars.f90->sourcefile~globals.f90 sourcefile~base.f90->sourcefile~globals.f90 sourcefile~base.f90->sourcefile~sgrid.f90 sourcefile~fbase.f90 fbase.F90 sourcefile~base.f90->sourcefile~fbase.f90 sourcefile~sbase.f90 sbase.F90 sourcefile~base.f90->sourcefile~sbase.f90 sourcefile~c_sol_var.f90->sourcefile~globals.f90 sourcefile~cubic_spline.f90->sourcefile~globals.f90 sourcefile~cubic_spline.f90->sourcefile~sll_m_spline_matrix.f90 sourcefile~sll_m_bsplines.f90 sll_m_bsplines.F90 sourcefile~cubic_spline.f90->sourcefile~sll_m_bsplines.f90 sourcefile~mhd3d_vars.f90->sourcefile~globals.f90 sourcefile~mhd3d_vars.f90->sourcefile~sol_var_mhd3d.f90 sourcefile~mhd3d_vars.f90->sourcefile~base.f90 sourcefile~mhd3d_vars.f90->sourcefile~sgrid.f90 sourcefile~boundaryfromfile.f90 boundaryFromFile.F90 sourcefile~mhd3d_vars.f90->sourcefile~boundaryfromfile.f90 sourcefile~c_rprofile.f90 c_rprofile.F90 sourcefile~mhd3d_vars.f90->sourcefile~c_rprofile.f90 sourcefile~hmap.f90 hmap.F90 sourcefile~mhd3d_vars.f90->sourcefile~hmap.f90 sourcefile~mod_mpi.f90->sourcefile~globals.f90 sourcefile~output_csv.f90->sourcefile~globals.f90 sourcefile~output_vtk.f90->sourcefile~globals.f90 sourcefile~readintools.f90->sourcefile~globals.f90 sourcefile~readintools.f90->sourcefile~mod_mpi.f90 sourcefile~readstate.f90->sourcefile~globals.f90 sourcefile~readstate.f90->sourcefile~base.f90 sourcefile~readstate.f90->sourcefile~readstate_vars.f90 sourcefile~readstate.f90->sourcefile~sgrid.f90 sourcefile~readstate.f90->sourcefile~fbase.f90 sourcefile~readstate.f90->sourcefile~hmap.f90 sourcefile~readstate.f90->sourcefile~sbase.f90 sourcefile~readstate_vars.f90->sourcefile~globals.f90 sourcefile~readstate_vars.f90->sourcefile~base.f90 sourcefile~readstate_vars.f90->sourcefile~sgrid.f90 sourcefile~readstate_vars.f90->sourcefile~hmap.f90 sourcefile~readstate_vars.f90->sourcefile~sbase.f90 sourcefile~restart_vars.f90->sourcefile~globals.f90 sourcefile~sgrid.f90->sourcefile~globals.f90 sourcefile~sll_m_spline_matrix.f90->sourcefile~sll_m_spline_matrix_banded.f90 sourcefile~sll_m_errors.f90 sll_m_errors.F90 sourcefile~sll_m_spline_matrix.f90->sourcefile~sll_m_errors.f90 sourcefile~sll_m_spline_matrix_base.f90 sll_m_spline_matrix_base.F90 sourcefile~sll_m_spline_matrix.f90->sourcefile~sll_m_spline_matrix_base.f90 sourcefile~sll_m_spline_matrix_dense.f90 sll_m_spline_matrix_dense.F90 sourcefile~sll_m_spline_matrix.f90->sourcefile~sll_m_spline_matrix_dense.f90 sourcefile~sll_m_working_precision.f90 sll_m_working_precision.F90 sourcefile~sll_m_spline_matrix.f90->sourcefile~sll_m_working_precision.f90 sourcefile~sll_m_assert.f90 sll_m_assert.F90 sourcefile~sll_m_spline_matrix_banded.f90->sourcefile~sll_m_assert.f90 sourcefile~sll_m_spline_matrix_banded.f90->sourcefile~sll_m_errors.f90 sourcefile~sll_m_spline_matrix_banded.f90->sourcefile~sll_m_spline_matrix_base.f90 sourcefile~sll_m_spline_matrix_banded.f90->sourcefile~sll_m_working_precision.f90 sourcefile~vmec.f90->sourcefile~globals.f90 sourcefile~vmec.f90->sourcefile~cubic_spline.f90 sourcefile~vmec.f90->sourcefile~readintools.f90 sourcefile~vmec.f90->sourcefile~vmec_readin.f90 sourcefile~vmec.f90->sourcefile~vmec_vars.f90 sourcefile~rprofile_bspline.f90 rprofile_bspline.F90 sourcefile~vmec.f90->sourcefile~rprofile_bspline.f90 sourcefile~vmec_readin.f90->sourcefile~globals.f90 sourcefile~vmec_readin.f90->sourcefile~cubic_spline.f90 sourcefile~vmec_vars.f90->sourcefile~globals.f90 sourcefile~vmec_vars.f90->sourcefile~cubic_spline.f90 sourcefile~vmec_vars.f90->sourcefile~c_rprofile.f90 sourcefile~write_modes.f90->sourcefile~globals.f90 sourcefile~write_modes.f90->sourcefile~output_csv.f90 sourcefile~boundaryfromfile.f90->sourcefile~globals.f90 sourcefile~boundaryfromfile.f90->sourcefile~fbase.f90 sourcefile~io_netcdf.f90 io_netcdf.F90 sourcefile~boundaryfromfile.f90->sourcefile~io_netcdf.f90 sourcefile~c_rprofile.f90->sourcefile~globals.f90 sourcefile~fbase.f90->sourcefile~globals.f90 sourcefile~hmap.f90->sourcefile~globals.f90 sourcefile~c_hmap.f90 c_hmap.F90 sourcefile~hmap.f90->sourcefile~c_hmap.f90 sourcefile~hmap_axisnb.f90 hmap_axisNB.F90 sourcefile~hmap.f90->sourcefile~hmap_axisnb.f90 sourcefile~hmap_cyl.f90 hmap_cyl.F90 sourcefile~hmap.f90->sourcefile~hmap_cyl.f90 sourcefile~hmap_frenet.f90 hmap_frenet.F90 sourcefile~hmap.f90->sourcefile~hmap_frenet.f90 sourcefile~hmap_knot.f90 hmap_knot.F90 sourcefile~hmap.f90->sourcefile~hmap_knot.f90 sourcefile~hmap_rz.f90 hmap_RZ.F90 sourcefile~hmap.f90->sourcefile~hmap_rz.f90 sourcefile~rprofile_bspline.f90->sourcefile~globals.f90 sourcefile~rprofile_bspline.f90->sourcefile~c_rprofile.f90 sourcefile~rprofile_bspline.f90->sourcefile~sll_m_bsplines.f90 sourcefile~sbase.f90->sourcefile~globals.f90 sourcefile~sbase.f90->sourcefile~sgrid.f90 sourcefile~sbase.f90->sourcefile~sll_m_spline_matrix.f90 sourcefile~sbase.f90->sourcefile~sll_m_bsplines.f90 sourcefile~basis1d.f90 basis1d.F90 sourcefile~sbase.f90->sourcefile~basis1d.f90 sourcefile~linalg.f90 linalg.F90 sourcefile~sbase.f90->sourcefile~linalg.f90 sourcefile~sll_m_boundary_condition_descriptors.f90 sll_m_boundary_condition_descriptors.F90 sourcefile~sbase.f90->sourcefile~sll_m_boundary_condition_descriptors.f90 sourcefile~sll_m_spline_interpolator_1d.f90 sll_m_spline_interpolator_1d.F90 sourcefile~sbase.f90->sourcefile~sll_m_spline_interpolator_1d.f90 sourcefile~sll_m_assert.f90->sourcefile~globals.f90 sourcefile~sll_m_bsplines.f90->sourcefile~sll_m_assert.f90 sourcefile~sll_m_bsplines.f90->sourcefile~sll_m_errors.f90 sourcefile~sll_m_bsplines.f90->sourcefile~sll_m_working_precision.f90 sourcefile~sll_m_bsplines_base.f90 sll_m_bsplines_base.F90 sourcefile~sll_m_bsplines.f90->sourcefile~sll_m_bsplines_base.f90 sourcefile~sll_m_bsplines_non_uniform.f90 sll_m_bsplines_non_uniform.F90 sourcefile~sll_m_bsplines.f90->sourcefile~sll_m_bsplines_non_uniform.f90 sourcefile~sll_m_bsplines_uniform.f90 sll_m_bsplines_uniform.F90 sourcefile~sll_m_bsplines.f90->sourcefile~sll_m_bsplines_uniform.f90 sourcefile~sll_m_spline_matrix_base.f90->sourcefile~sll_m_working_precision.f90 sourcefile~sll_m_spline_matrix_dense.f90->sourcefile~sll_m_assert.f90 sourcefile~sll_m_spline_matrix_dense.f90->sourcefile~sll_m_errors.f90 sourcefile~sll_m_spline_matrix_dense.f90->sourcefile~sll_m_spline_matrix_base.f90 sourcefile~sll_m_spline_matrix_dense.f90->sourcefile~sll_m_working_precision.f90 sourcefile~basis1d.f90->sourcefile~globals.f90 sourcefile~basis1d.f90->sourcefile~linalg.f90 sourcefile~c_hmap.f90->sourcefile~globals.f90 sourcefile~hmap_axisnb.f90->sourcefile~globals.f90 sourcefile~hmap_axisnb.f90->sourcefile~analyze_vars.f90 sourcefile~hmap_axisnb.f90->sourcefile~mod_mpi.f90 sourcefile~hmap_axisnb.f90->sourcefile~output_csv.f90 sourcefile~hmap_axisnb.f90->sourcefile~output_vtk.f90 sourcefile~hmap_axisnb.f90->sourcefile~readintools.f90 sourcefile~hmap_axisnb.f90->sourcefile~fbase.f90 sourcefile~hmap_axisnb.f90->sourcefile~c_hmap.f90 sourcefile~hmap_axisnb.f90->sourcefile~io_netcdf.f90 sourcefile~output_netcdf.f90 output_netcdf.F90 sourcefile~hmap_axisnb.f90->sourcefile~output_netcdf.f90 sourcefile~hmap_cyl.f90->sourcefile~globals.f90 sourcefile~hmap_cyl.f90->sourcefile~readintools.f90 sourcefile~hmap_cyl.f90->sourcefile~c_hmap.f90 sourcefile~hmap_frenet.f90->sourcefile~globals.f90 sourcefile~hmap_frenet.f90->sourcefile~analyze_vars.f90 sourcefile~hmap_frenet.f90->sourcefile~output_csv.f90 sourcefile~hmap_frenet.f90->sourcefile~output_vtk.f90 sourcefile~hmap_frenet.f90->sourcefile~readintools.f90 sourcefile~hmap_frenet.f90->sourcefile~c_hmap.f90 sourcefile~hmap_frenet.f90->sourcefile~output_netcdf.f90 sourcefile~hmap_knot.f90->sourcefile~globals.f90 sourcefile~hmap_knot.f90->sourcefile~readintools.f90 sourcefile~hmap_knot.f90->sourcefile~c_hmap.f90 sourcefile~hmap_rz.f90->sourcefile~globals.f90 sourcefile~hmap_rz.f90->sourcefile~c_hmap.f90 sourcefile~io_netcdf.f90->sourcefile~globals.f90 sourcefile~linalg.f90->sourcefile~globals.f90 sourcefile~sll_m_boundary_condition_descriptors.f90->sourcefile~sll_m_working_precision.f90 sourcefile~sll_m_bsplines_base.f90->sourcefile~sll_m_assert.f90 sourcefile~sll_m_bsplines_base.f90->sourcefile~sll_m_working_precision.f90 sourcefile~sll_m_bsplines_non_uniform.f90->sourcefile~sll_m_assert.f90 sourcefile~sll_m_bsplines_non_uniform.f90->sourcefile~sll_m_working_precision.f90 sourcefile~sll_m_bsplines_non_uniform.f90->sourcefile~sll_m_bsplines_base.f90 sourcefile~sll_m_bsplines_uniform.f90->sourcefile~sll_m_assert.f90 sourcefile~sll_m_bsplines_uniform.f90->sourcefile~sll_m_errors.f90 sourcefile~sll_m_bsplines_uniform.f90->sourcefile~sll_m_working_precision.f90 sourcefile~sll_m_bsplines_uniform.f90->sourcefile~sll_m_bsplines_base.f90 sourcefile~sll_m_spline_interpolator_1d.f90->sourcefile~sll_m_spline_matrix.f90 sourcefile~sll_m_spline_interpolator_1d.f90->sourcefile~sll_m_assert.f90 sourcefile~sll_m_spline_interpolator_1d.f90->sourcefile~sll_m_errors.f90 sourcefile~sll_m_spline_interpolator_1d.f90->sourcefile~sll_m_working_precision.f90 sourcefile~sll_m_spline_interpolator_1d.f90->sourcefile~sll_m_boundary_condition_descriptors.f90 sourcefile~sll_m_spline_interpolator_1d.f90->sourcefile~sll_m_bsplines_base.f90 sourcefile~sll_m_spline_1d.f90 sll_m_spline_1d.F90 sourcefile~sll_m_spline_interpolator_1d.f90->sourcefile~sll_m_spline_1d.f90 sourcefile~output_netcdf.f90->sourcefile~globals.f90 sourcefile~output_netcdf.f90->sourcefile~io_netcdf.f90 sourcefile~sll_m_spline_1d.f90->sourcefile~sll_m_assert.f90 sourcefile~sll_m_spline_1d.f90->sourcefile~sll_m_working_precision.f90 sourcefile~sll_m_spline_1d.f90->sourcefile~sll_m_bsplines_base.f90

Files dependent on this one

sourcefile~~mhd3d_minimize.f90~~AfferentGraph sourcefile~mhd3d_minimize.f90 mhd3d_minimize.F90 sourcefile~mhd3d.f90 mhd3d.F90 sourcefile~mhd3d.f90->sourcefile~mhd3d_minimize.f90 sourcefile~gvec_post.f90 gvec_post.F90 sourcefile~gvec_post.f90->sourcefile~mhd3d.f90 sourcefile~rungvec.f90 rungvec.F90 sourcefile~rungvec.f90->sourcefile~mhd3d.f90 sourcefile~state.f90 state.F90 sourcefile~state.f90->sourcefile~mhd3d.f90 sourcefile~gvec.f90 gvec.F90 sourcefile~gvec.f90->sourcefile~rungvec.f90 sourcefile~run.f90 run.F90 sourcefile~run.f90->sourcefile~rungvec.f90

Source Code

!===================================================================================================================================
! Copyright (c) 2025 GVEC Contributors, Max Planck Institute for Plasma Physics
! License: MIT
!===================================================================================================================================
#include "defines.FPP"

!===================================================================================================================================
!>
!!# Module **MHD3D minimize**
!!
!! CONTAINS minimizer for MHD3D functional
!!
!===================================================================================================================================
MODULE MODgvec_MHD3D_minimize
    ! MODULES
    USE MODgvec_Globals, ONLY:wp,abort,UNIT_stdOut,fmt_sep,MPIRoot,enter_subregion,exit_subregion
    USE MODgvec_Sol_Var_MHD3D,ONLY: t_sol_var_MHD3D
    IMPLICIT NONE

    ! PRIVATE
    ! PUBLIC t_minimizer_mhd3d

    !-----------------------------------------------------------------------------------------------------------------------------------
    ! TYPES
    !-----------------------------------------------------------------------------------------------------------------------------------
    TYPE, ABSTRACT :: a_minimizer_vars
        CHARACTER(LEN=40) :: MinimizerType !! defines the minimization algorithm: 0 = Gradient-Descent, 10 = Accelerated Gradient-Descent
        LOGICAL   :: restart_iter, logger_is_initialized
        INTEGER   :: JacCheck !! switch for restarts, if detJ<0 JacCheck=-1
        INTEGER   :: iter,nStepDecreased,nSkip_Jac,nSkip_dw
        INTEGER   :: lastoutputIter, logiter_ramp, logscreen
        REAL(wp)  :: dt,deltaW, dW_allowed
        REAL(wp)  :: t_pseudo,Fnorm(3),Fnorm0(3),Fnorm_old(3),W_MHD3D_0

        ! Logging variables
        REAL(wp) :: min_dt_out,max_dt_out,min_dw_out,max_dw_out,sum_dW_out
        LOGICAL  :: DoCheckDistance, DoCheckAxis
        INTEGER  :: outputIter, nlogScreen, logIter, logUnit, StartTimeArray(8)

        TYPE(t_sol_var_MHD3D), ALLOCATABLE :: dofs(:)      !! degrees of freedom at levels (k-1),(k),(k+1)
        TYPE(t_sol_var_MHD3D), ALLOCATABLE :: force(:)     !! force
        TYPE(t_sol_var_MHD3D), ALLOCATABLE :: temp_dofs(:) !! temporary for update
    END TYPE a_minimizer_vars

    !===================================================================================================================================
    !> State variables for a Gradient descent minimizer
    !!
    !===================================================================================================================================
    TYPE, EXTENDS(a_minimizer_vars) :: t_gradient_descent_vars
    END TYPE t_gradient_descent_vars

    !===================================================================================================================================
    !> State variables for an Accelerated Gradient-Descent descent minimizer
    !!
    !===================================================================================================================================
    TYPE, EXTENDS(a_minimizer_vars) :: t_accelerated_gradient_descent_vars
        REAL(wp) :: Vnorm(3)
        REAL(wp), ALLOCATABLE  :: tau(:)
        INTEGER   :: ndamp
        REAL(wp)  :: tau_bar
        TYPE(t_sol_var_MHD3D), ALLOCATABLE :: velocity(:) !! 'velocity' in minimizer
    END TYPE t_accelerated_gradient_descent_vars

    !===================================================================================================================================
    !> Minimizer object
    !!
    !===================================================================================================================================
    TYPE :: t_minimizer_mhd3d
        !-------------------------------------------------------------------------------------------------------------------------------
        LOGICAL   :: initialized !! whether the object is initialized or ot
        INTEGER   :: MinType !! gradient descent = 0, accelerated gradient descent = 10
        CLASS(a_minimizer_vars), ALLOCATABLE :: vars  !!! depend on the MinimizerType
        !-------------------------------------------------------------------------------------------------------------------------------
        CONTAINS
        PROCEDURE :: minimize         => MinimizeMHD3D_descent
        PROCEDURE :: reset            => MinimizeMHD3d_ResetDescent
        PROCEDURE :: StartLogging     => StartLogging_MHD3D
        PROCEDURE :: Logging          => Logging_MHD3D
        PROCEDURE :: free             => Free_minimizer
    END TYPE t_minimizer_mhd3d

    !===================================================================================================================================

    CONTAINS


    !===================================================================================================================================
    !> Initialization method for a minimizer
    !!
    !===================================================================================================================================
    SUBROUTINE new_minimizer(&
            sf, varsize_in, dt_initial, MinType_in, dW_allowed_in,& ! Minimizer
            DoCheckDistance, DoCheckAxis,& !what to log
            outputIter, nlogScreen, logIter& !when to log
        )
        !-----------------------------------------------------------------------------------------------------------------------------------
        ! MODULES
        USE MODgvec_MHD3D_evalFunc, ONLY: EvalForce
        !-----------------------------------------------------------------------------------------------------------------------------------
        ! INPUT VARIABLES
        INTEGER , INTENT(IN) :: varsize_in(:) !! size of the dofs
        REAL(wp), INTENT(IN) :: dt_initial !! initial stepsize for the minimization
        REAL(wp), INTENT(IN) :: dW_allowed_in !! for minimizer, accept step if dW<dW_allowed*W_MHD(iter=0)
        INTEGER, INTENT(IN)  :: MinType_in !! gradient descent = 0, accelerated gradient descent = 10
        LOGICAL, INTENT(IN)  :: DoCheckDistance !! TRUE: check distance between solutions of two log output states
        LOGICAL, INTENT(IN)  :: DoCheckAxis !! TRUE: check axis position
        INTEGER, INTENT(IN)  :: outputIter !! number of iterations after which output files are written
        INTEGER, INTENT(IN)  :: nlogScreen !! number of log outputs after a screen output is written
        INTEGER, INTENT(IN)  :: logIter !! number of iterations after which a screen log is written
        !-----------------------------------------------------------------------------------------------------------------------------------
        ! OUTPUT VARIABLES
        TYPE(t_minimizer_mhd3d),ALLOCATABLE, INTENT(INOUT) :: sf !! allocatable minimizer object
        !-----------------------------------------------------------------------------------------------------------------------------------
        ! LOCAL VARIABLES
        INTEGER :: i !! iteration variable
        !===================================================================================================================================
        ALLOCATE(sf)

        sf%MinType = MinType_in
        IF(MinType_in.EQ.0)THEN
            ALLOCATE(t_gradient_descent_vars :: sf%vars)
            sf%vars%MinimizerType="Gradient-Descent"
        ELSEIF(MinType_in.EQ.10)THEN
            ALLOCATE(t_accelerated_gradient_descent_vars :: sf%vars)
            sf%vars%MinimizerType="Accelerated Gradient-Descent"
        ELSE
            CALL abort(__STAMP__,&
                       "requested MinimizeType does not exist, expecting 0 or 10",intinfo=MinType_in,&
                       TypeInfo="InvalidParameterError")
        END IF
        ASSOCIATE(vars=>sf%vars)
            vars%dt = dt_initial
            vars%dW_allowed = dW_allowed_in

            ALLOCATE(vars%dofs(-3:1))
            CALL vars%dofs(1)%init(varsize_in)
            DO i=-3,0
                CALL vars%dofs(i)%copy(vars%dofs(1))
            END DO
            ALLOCATE(vars%force(-1:0))
            DO i=-1,0
                CALL vars%force(i)%copy(vars%dofs(1))
            END DO

            ALLOCATE(vars%temp_dofs(-1:1))
            DO i=-1,1
                CALL vars%temp_dofs(i)%copy(vars%dofs(1))
            END DO

            ! variables for the accelerated Gradient descent
            SELECT TYPE(vars)
            TYPE IS(t_accelerated_gradient_descent_vars)
                ALLOCATE(vars%velocity(-1:1))
                DO i=-1,1
                    CALL vars%velocity(i)%copy(vars%dofs(1))
                END DO
                vars%tau_bar = 0.075_wp
                vars%ndamp = 10
                ALLOCATE(vars%tau(vars%ndamp))
                vars%tau=0.0_wp
                vars%Vnorm = 0.0_wp
            END SELECT !Type
            vars%JacCheck = 1

            vars%nstepDecreased = 0
            vars%nSkip_Jac = 0
            vars%t_pseudo = 0
            vars%lastOutputIter = 0
            vars%iter = 0
            vars%logiter_ramp = 1
            vars%logscreen = 1
            vars%nSkip_dw = 0
            vars%JacCheck = 1



            vars%restart_iter = .TRUE.
            vars%logger_is_initialized = .FALSE.

            vars%DoCheckDistance = DoCheckDistance
            vars%DoCheckAxis = DoCheckAxis

            vars%outputIter = outputIter
            vars%nlogScreen = nlogScreen
            vars%logIter = logIter

            vars%Fnorm = 10.0_wp
            vars%Fnorm0 = 10.0_wp
            vars%W_MHD3D_0 = 0.0_wp
            vars%deltaW = 0.0_wp
        END ASSOCIATE !vars
        sf%initialized = .TRUE.
    END SUBROUTINE new_minimizer

    !===================================================================================================================================
    !> Reset the minimizer state
    !!
    !! Called during the first iteration or after resetting the minimizer, e.g. due to detJ<0.
    !! Overwrites the degrees of freedom (dofs(-2:-1)) with the initial state (dofs(0)).
    !! For the accelerated gradient descent also the history (e.g. tau) is reset.
    !===================================================================================================================================
    SUBROUTINE MinimizeMHD3d_ResetDescent(sf)
        ! MODULES
        USE MODgvec_MHD3D_EvalFunc, ONLY: EvalAux, EvalForce, EvalEnergy
        !-------------------------------------------------------------------------------------------------------------------------------
        ! INPUT VARIABLES
        CLASS(t_minimizer_mhd3d), INTENT(INOUT) :: sf !! minimizer
        !-------------------------------------------------------------------------------------------------------------------------------
        ! OUTPUT VARIABLES
        !-------------------------------------------------------------------------------------------------------------------------------
        ! LOCAL VARIABLES
        !===============================================================================================================================
        ASSOCIATE(vars=>sf%vars)
            vars%JacCheck=1 !abort if detJ<0
            CALL EvalAux(vars%dofs(0), vars%JacCheck)
            vars%dofs(0)%W_MHD3D= EvalEnergy(vars%dofs(0),.FALSE.,vars%JacCheck)
            vars%W_MHD3D_0 = vars%dofs(0)%W_MHD3D
            CALL EvalForce( vars%dofs(0),.FALSE.,vars%JacCheck,vars%force(0))
            vars%Fnorm0 = SQRT(vars%force(0)%norm_2())
            vars%Fnorm = vars%Fnorm0
            vars%Fnorm_old = 1.1_wp*vars%Fnorm0
            CALL vars%dofs(-1)%set_to(vars%dofs(0)) !last state
            CALL vars%dofs(-2)%set_to(vars%dofs(0)) !state at last logging interval

            !for hirshman method
            SELECT TYPE(vars)
            TYPE IS(t_accelerated_gradient_descent_vars)
                CALL vars%velocity(-1)%set_to(0.0_wp)
                CALL vars%velocity( 0)%set_to(0.0_wp)
                vars%tau(1:vars%ndamp)=0.15_wp/vars%dt
                vars%tau_bar = 0.075_wp
            END SELECT

            vars%min_dt_out=1.0e+30_wp
            vars%max_dt_out=0.0_wp
            vars%min_dW_out=1.0e+30_wp
            vars%max_dW_out=-1.0e+30_wp
            vars%sum_dW_out=0.0_wp
            vars%nSkip_dW =0
            IF(vars%restart_iter) vars%restart_iter=.FALSE.
        END ASSOCIATE !vars
    END SUBROUTINE MinimizeMHD3d_ResetDescent

    !===================================================================================================================================
    !> Initialization of the Logging
    !!
    !! NOTE: Opens and writes to a csv file named in the style of logMinimizer_*
    !===================================================================================================================================
    SUBROUTINE StartLogging_MHD3D(sf)
        ! MODULES
        USE MODgvec_Globals,     ONLY: GETFREEUNIT
        USE MODgvec_Output_Vars, ONLY: ProjectName,outputLevel
        USE MODgvec_MHD3D_visu,  ONLY: checkPos
        IMPLICIT NONE
        !-------------------------------------------------------------------------------------------------------------------------------
        ! INPUT VARIABLES
        CLASS(t_minimizer_mhd3d), INTENT(INOUT) :: sf !! minimizer
        !-------------------------------------------------------------------------------------------------------------------------------
        ! OUTPUT VARIABLES
        !-------------------------------------------------------------------------------------------------------------------------------
        ! LOCAL VARIABLES
        CHARACTER(LEN=255)  :: fileString !! filename
        INTEGER             :: TimeArray(8),iLogDat
        REAL(wp)            :: Pos(2,2),W_MHD3D
        INTEGER,PARAMETER   :: nLogDat=25
        REAL(wp)            :: LogDat(1:nLogDat)
        !=================================================================================================================================
        IF(.NOT.MPIroot) RETURN
        __PERFON('log_output')
        ASSOCIATE(vars=>sf%vars)
            W_MHD3D=vars%dofs(0)%W_MHD3D
            CALL DATE_AND_TIME(values=TimeArray) ! get System time
            WRITE(UNIT_stdOut,'(A,E11.4,A)')'%%%%%  START ITERATION, dt= ',vars%dt, '  %%%%%%%%%%%%%%%%%'
            WRITE(UNIT_stdOut,'(A,I4.2,"-",I2.2,"-",I2.2,1X,I2.2,":",I2.2,":",I2.2)') &
                            '%% Sys date : ',timeArray(1:3),timeArray(5:7)
            WRITE(UNIT_stdOut,'(A,3E21.14)') &
                    '%% dU = |Force|= ',vars%Fnorm(1:3)
            SELECT TYPE(vars)
            TYPE IS (t_accelerated_gradient_descent_vars)
                WRITE(UNIT_stdOut,'(A,E11.4,A,3E11.4)') &
                    '%% accel.GD: tau= ',vars%tau_bar,' |vel|= ',vars%Vnorm(1:3)
            END SELECT

            WRITE(UNIT_stdOut,'(40(" -"))')
            !------------------------------------
            vars%StartTimeArray=TimeArray !save first time stamp

            vars%logUnit=GETFREEUNIT()
            WRITE(FileString,'("logMinimizer_",A,"_",I4.4,".csv")')TRIM(ProjectName),outputLevel
            OPEN(UNIT     = vars%logUnit       ,&
                FILE     = TRIM(FileString) ,&
                STATUS   = 'REPLACE'   ,&
                ACCESS   = 'SEQUENTIAL' )
            !header
            iLogDat=0
            WRITE(vars%logUnit,'(A)',ADVANCE="NO")'"#iterations","runtime(s)","min_dt","max_dt"'
            WRITE(vars%logUnit,'(A)',ADVANCE="NO")',"W_MHD3D","min_dW","max_dW","sum_dW"'
            WRITE(vars%logUnit,'(A)',ADVANCE="NO")',"normF_X1","normF_X2","normF_LA"'
            LogDat(ilogDat+1:iLogDat+11)=(/0.0_wp,0.0_wp,vars%dt,vars%dt,W_MHD3D,0.0_wp,0.0_wp,0.0_wp,vars%Fnorm(1:3)/)
            iLogDat=11
            SELECT TYPE(vars)
            TYPE IS (t_accelerated_gradient_descent_vars)
                WRITE(vars%logUnit,'(A)',ADVANCE="NO")',"tau","normV_X1","normV_X2","normV_LA"'
                LogDat(ilogDat+1:iLogDat+4)=(/vars%tau_bar,vars%Vnorm(1:3)/)
                iLogDat=iLogDat+4
            END SELECT
            IF(vars%doCheckDistance) THEN
                WRITE(vars%logUnit,'(A)',ADVANCE="NO")',"max_Dist","avg_Dist"'
                LogDat(iLogDat+1:iLogDat+2)=(/0.0_wp,0.0_wp/)
                iLogDat=iLogDat+2
            END IF!doCheckDistance
            IF(vars%doCheckAxis) THEN
                WRITE(vars%logUnit,'(A)',ADVANCE="NO")',"X1_axis_0","X2_axis_0","X1_axis_1","X2_axis_1"'
                CALL CheckPos(vars%dofs(0),0.0_wp,2,Pos)
                LogDat(iLogDat+1:iLogDat+4)=RESHAPE(Pos,(/4/))
                iLogDat=iLogDat+4
            END IF!doCheckAxis

            WRITE(vars%logUnit,'(A)')' '
            !first data line
            WRITE(vars%logUnit,'(*(e23.15,:,","))') logDat(1:iLogDat)
            vars%logger_is_initialized = .TRUE.
        END ASSOCIATE !vars
        __PERFOFF('log_output')
    END SUBROUTINE StartLogging_MHD3D

    !===================================================================================================================================
    !> Log the current minimizer and functional state
    !!
    !! NOTE: Writes to a csv file named in the style of logMinimizer_*
    !===================================================================================================================================
    SUBROUTINE Logging_MHD3D(sf, quiet)
        ! MODULES
        USE MODgvec_MHD3D_visu, ONLY: checkDistance
        USE MODgvec_MHD3D_visu, ONLY: checkPos
        IMPLICIT NONE
        !-------------------------------------------------------------------------------------------------------------------------------
        ! INPUT VARIABLES
        CLASS(t_minimizer_mhd3d), INTENT(INOUT) :: sf
        LOGICAL, INTENT(IN) :: quiet !! True: no screen output
        !-------------------------------------------------------------------------------------------------------------------------------
        ! OUTPUT VARIABLES
        !-------------------------------------------------------------------------------------------------------------------------------
        ! LOCAL VARIABLES
        INTEGER             :: TimeArray(8),runtime_ms,iLogDat
        REAL(wp)            :: Pos(2,2),maxDist,avgDist,W_MHD3D
        INTEGER,PARAMETER   :: nLogDat=25
        REAL(wp)            :: LogDat(1:nLogDat)
        !=================================================================================================================================
        IF(.NOT.MPIroot) RETURN
        __PERFON('log_output')
        ASSOCIATE(vars=>sf%vars)
            CALL DATE_AND_TIME(values=TimeArray) ! get System time
            W_MHD3D=vars%dofs(0)%W_MHD3D
            IF(.NOT.quiet)THEN
                WRITE(UNIT_stdOut,'(80("%"))')
                WRITE(UNIT_stdOut,'(A,I4.2,"-",I2.2,"-",I2.2,1X,I2.2,":",I2.2,":",I2.2)') &
                                '%% Sys date : ',timeArray(1:3),timeArray(5:7)
                WRITE(UNIT_stdOut,'(A,I8,A,2I8,A,E11.4,A,2E11.4,A,E21.14,A,3E12.4)') &
                                '%% #ITERATIONS= ',vars%iter,', #skippedIter (Jac/dW)= ',vars%nSkip_Jac,vars%nSkip_dW, &
                        '\n%% t_pseudo= ',vars%t_pseudo,', min/max dt= ',vars%min_dt_out,vars%max_dt_out, &
                        '\n%% W_MHD3D= ',W_MHD3D,', min/max/sum deltaW= ' , vars%min_dW_out,vars%max_dW_out,vars%sum_dW_out
                WRITE(UNIT_stdOut,'(A,3E21.14)') &
                            '%% dU = |Force|= ',vars%Fnorm(1:3)
                !------------------------------------
            END IF!.NOT.quiet

            iLogDat=0
            runtime_ms=MAX(0,SUM((timeArray(5:8)-vars%StartTimearray(5:8))*(/360000,6000,100,1/)))
            LogDat(ilogDat+1:iLogDat+11)=(/REAL(vars%iter,wp),REAL(runtime_ms,wp)/100.0_wp, &
                                            vars%min_dt_out,vars%max_dt_out,&
                                            W_MHD3D,vars%min_dW_out,vars%max_dW_out,vars%sum_dW_out, &
                                            vars%Fnorm(1:3)/)
            iLogDat=11
            SELECT TYPE(vars)
            TYPE IS (t_accelerated_gradient_descent_vars)
                IF(.NOT.quiet)THEN
                WRITE(UNIT_stdOut,'(A,E11.4,A,3E11.4)') &
                        '%% accel.GD: tau= ',vars%tau_bar,' |vel|= ',vars%Vnorm(1:3)
                END IF!.NOT.quiet
                LogDat(ilogDat+1:iLogDat+4)=(/vars%tau_bar,vars%Vnorm(1:3)/)
                iLogDat=iLogDat+4
            END SELECT
            IF(vars%doCheckDistance) THEN
                CALL CheckDistance(vars%dofs(0),vars%dofs(-2),maxDist,avgDist)
                CALL vars%dofs(-2)%set_to(vars%dofs(0))
                IF(.NOT.quiet)THEN
                WRITE(UNIT_stdOut,'(A,2E11.4)') &
                '               %% Dist to last log (max/avg) : ',maxDist,avgDist
                END IF!.NOT.quiet
                LogDat(iLogDat+1:iLogDat+2)=(/maxDist,avgDist/)
                iLogDat=iLogDat+2
            END IF!doCheckDistance
            IF(vars%doCheckAxis) THEN
                CALL CheckPos(vars%dofs(0),0.0_wp,2,Pos)
                IF(.NOT.quiet)THEN
                SWRITE(UNIT_stdOut,'(2(A,2E22.14))') &
                    '%% axis position (X1,X2,zeta=0     ): ',Pos(1:2,1), &
                '\n%% axis position (X1,X2,zeta=pi/nfp): ',Pos(1:2,2)
                END IF!.NOT.quiet
                LogDat(iLogDat+1:iLogDat+4)=RESHAPE(Pos,(/4/))
                iLogDat=iLogDat+4
            END IF !doCheckAxis

            IF(.NOT.quiet)THEN
                WRITE(UNIT_stdOut,'(40(" -"))')
            END IF!.NOT.quiet
            WRITE(vars%logUnit,'(*(e23.15,:,","))') logDat(1:iLogDat)
        END ASSOCIATE !vars
        __PERFOFF('log_output')
    END SUBROUTINE Logging_MHD3D

    !===================================================================================================================================
    !> Core minimization routine
    !!
    !! Iterates until the (force-)tolerance or the maximum number of iterations is reached.
    !! Also writes output files after set number of iterations
    !===================================================================================================================================
    SUBROUTINE MinimizeMHD3D_descent(sf, abstol, maxIter_in)
        USE MODgvec_MHD3D_EvalFunc, ONLY: EvalAux, EvalForce, EvalEnergy
        USE MODgvec_Analyze, ONLY:analyze
        USE MODgvec_Restart, ONLY:WriteState
        USE MODgvec_MHD3D_visu, ONLY:WriteSFLoutfile
        USE MODgvec_sol_var_MHD3D, ONLY: t_sol_var_MHD3D
        IMPLICIT NONE

        REAL(wp), INTENT(IN) :: abstol !! tolerance on the forces. If reached terminaters the minimization
        INTEGER, INTENT(IN)  :: maxIter_in !! maximum number of iterations after which the iterations are terminated
        !-----------------------------------------------------------------------------------------------------------------------------------
        ! OUTPUT VARIABLES
        CLASS(t_minimizer_mhd3d), INTENT(INOUT) :: sf !! minimizer
        !-----------------------------------------------------------------------------------------------------------------------------------
        ! LOCAL VARIABLES
        INTEGER :: maxIter !! maximum number of iterations
        !=================================================================================================================================
        ASSOCIATE(vars=>sf%vars)
            maxIter = vars%iter + maxIter_in
            DO WHILE(vars%iter.LT.maxIter)
                IF((vars%restart_iter))THEN
                    CALL sf%reset()
                END IF !before first iteration or after restart Jac<0

                IF(.NOT.vars%logger_is_initialized)THEN
                    CALL sf%StartLogging()
                END IF
                !COMPUTE NEW SOLUTION P(1) as a prediction
                SELECT TYPE(vars)
                TYPE IS(t_gradient_descent_vars) !gradient descent, previously used for minimizerType=0
                        CALL vars%temp_dofs(1)%AXBY(1.0_wp,vars%dofs(0),vars%dt,vars%force(0)) !overwrites P(1), predicts solution U(1)
                TYPE IS(t_accelerated_gradient_descent_vars) !hirshman method
                        !tau is damping parameter
                        vars%tau(1:vars%ndamp-1) = vars%tau(2:vars%ndamp) !save old

                        !ln(|F_n|^2/|F_{n-1}|^2), Fnorm=|F_X1|,|F_X2|,|F_LA|
                        vars%tau(vars%ndamp)  = MIN(0.15_wp,ABS(LOG(SUM(vars%Fnorm**2)/SUM(vars%Fnorm_old**2))))/vars%dt

                        vars%tau_bar = 0.5_wp*vars%dt*SUM(vars%tau)/REAL(vars%ndamp,wp)   !=1/2 * tauavg
                        CALL vars%velocity(1)%AXBY(((1.0_wp-vars%tau_bar)/(1.0_wp+vars%tau_bar)),vars%velocity(0),(vars%dt/(1.0_wp+vars%tau_bar)),vars%force(0)) !velocity V(1)
                        CALL vars%temp_dofs(1)%AXBY(1.0_wp,vars%dofs(0),vars%dt,vars%velocity(1)) !overwrites P(1), predicst solution U(1)
                        vars%Vnorm=SQRT(vars%velocity(1)%norm_2())
                END SELECT !Type

                vars%JacCheck=2 !no abort,if detJ<0, JacCheck=-1

                vars%temp_dofs(1)%W_MHD3D=EvalEnergy(vars%temp_dofs(1),.TRUE.,vars%JacCheck)
                IF(vars%JacCheck.EQ.-1)THEN
                    vars%dt=0.9_wp*vars%dt
                    vars%nstepDecreased=vars%nStepDecreased+1
                    vars%nSkip_Jac=vars%nSkip_Jac+1
                    vars%restart_iter=.TRUE.
                    CALL vars%dofs(0)%set_to(vars%dofs(-3)) !reset to initial state
                    SWRITE(UNIT_stdOut,'(8X,I8,A,E11.4,A)')vars%iter,'...detJac<0, decrease stepsize to dt=',vars%dt,  ' and RESTART simulation!!!!!!!'
                ELSE
                    !detJ>0
                    vars%deltaW=vars%temp_dofs(1)%W_MHD3D-vars%dofs(0)%W_MHD3D!should be <=0,
                    IF(vars%deltaW.LE.vars%dW_allowed*vars%W_MHD3D_0)THEN !valid step /hirshman method accept W increase!
                        IF(ALL(vars%Fnorm.LE.abstol))THEN
                            CALL sf%Logging(.FALSE.)
                            SWRITE(UNIT_stdOut,'(4x,A)')'==>Iteration finished, |force| in relative tolerance'
                            EXIT !DO LOOP
                        END IF
                        vars%iter=vars%iter+1
                        vars%t_pseudo=vars%t_pseudo+vars%dt
                        ! for simple gradient & hirshman
                        CALL vars%dofs(-1)%set_to(vars%dofs(0))
                        CALL vars%dofs(0)%set_to(vars%temp_dofs(1))
                        ! for hirshman method
                        SELECT TYPE(vars)
                        TYPE IS(t_accelerated_gradient_descent_vars)
                            CALL vars%velocity(-1)%set_to(vars%velocity(0))
                            CALL vars%velocity(0)%set_to(vars%velocity(1))
                        END SELECT
                        CALL EvalForce(vars%temp_dofs(1),.FALSE.,vars%JacCheck,vars%force(0)) !evalAux was already called on P(1)=U(0), so that its set false here.
                        vars%Fnorm_old=vars%Fnorm
                        vars%Fnorm=SQRT(vars%force(0)%norm_2())
                        vars%nstepDecreased=0
                        vars%min_dt_out=MIN(vars%min_dt_out,vars%dt)
                        vars%max_dt_out=MAX(vars%max_dt_out,vars%dt)
                        vars%min_dW_out=MIN(vars%min_dW_out,vars%deltaW)
                        vars%max_dW_out=MAX(vars%max_dW_out,vars%deltaW)
                        vars%sum_dW_out=vars%sum_dW_out+vars%deltaW
                        IF(MOD(vars%iter,vars%logIter_ramp).EQ.0)THEN
                            CALL sf%Logging(.NOT.((vars%logIter_ramp.GE.vars%logIter).AND.(MOD(vars%logscreen,vars%nLogScreen).EQ.0)))
                            IF(.NOT.(vars%logIter_ramp.LT.vars%logIter))THEN !only reset for logIter
                                vars%logscreen=vars%logscreen+1
                                vars%min_dt_out=1.0e+30_wp
                                vars%max_dt_out=0.0_wp
                                vars%min_dW_out=1.0e+30_wp
                                vars%max_dW_out=-1.0e+30_wp
                                vars%sum_dW_out=0.0_wp
                                vars%nSkip_dW =0
                            END IF
                            vars%logIter_ramp=MIN(vars%logIter,vars%logIter_ramp*2)
                        END IF
                    ELSE !not a valid step, decrease timestep and skip P(1)
                        vars%dt=0.9_wp*vars%dt
                        vars%nstepDecreased=vars%nStepDecreased+1
                        vars%nSkip_dW=vars%nSkip_dW+1
                        vars%restart_iter=.TRUE.
                        SWRITE(UNIT_stdOut,'(8X,I8,A,E8.2,A,E8.1,A,E11.4)')vars%iter,'...deltaW=',vars%deltaW,'>',vars%dW_allowed,&
                        '*W_MHD3D_0, skip step and decrease stepsize to dt=',vars%dt
                    END IF
                END IF !JacCheck
                IF(vars%nStepDecreased.GT.130) THEN ! 0.9^130 ~10^-6
                    SWRITE(UNIT_stdOut,'(A,E21.11)')'Iteration stopped since timestep has been decreased by 0.9^130: ', vars%dt
                    SWRITE(UNIT_stdOut,fmt_sep)
                    RETURN
                END IF
                IF((MOD(vars%iter,vars%outputIter).EQ.0).AND.(vars%lastoutputIter.NE.vars%iter))THEN
                    __PERFON('output')
                    SWRITE(UNIT_stdOut,'(A)')'##########################  OUTPUT ##################################'
                    CALL Analyze(vars%iter, vars%dofs(0), vars%force(0))
                    CALL WriteState(vars%dofs(0),vars%iter)
                    SWRITE(UNIT_stdOut,'(A)')'#####################################################################'
                    vars%lastOutputIter=vars%iter
                    __PERFOFF('output')
                END IF
            END DO !iter

            IF(vars%iter.GE.MaxIter)THEN
                SWRITE(UNIT_stdOut,'(A,E21.11)')"maximum iteration count exceeded"
            END IF
            SWRITE(UNIT_stdOut,'(A)') "... DONE."
            SWRITE(UNIT_stdOut,fmt_sep)
            IF(vars%lastoutputIter.NE.vars%iter)THEN
                CALL Analyze(MIN(vars%iter,MaxIter), vars%dofs(0), vars%force(0))
                CALL WriteState(vars%dofs(0),MIN(vars%iter,MaxIter))
            END IF
            CALL writeSFLoutfile(vars%dofs(0),MIN(vars%iter,MaxIter))
        END ASSOCIATE !vars
    END SUBROUTINE MinimizeMHD3D_descent

    !===================================================================================================================================
    !> Finalization method for a minimizer
    !!
    !! NOTE: Also closes the logging file
    !===================================================================================================================================
    SUBROUTINE Free_minimizer(sf)
        ! MODULES
        !-------------------------------------------------------------------------------------------------------------------------------
        ! INPUT VARIABLES
        CLASS(t_minimizer_mhd3d), INTENT(INOUT) :: sf !! minimizer
        !-------------------------------------------------------------------------------------------------------------------------------
        ! OUTPUT VARIABLES
        !-------------------------------------------------------------------------------------------------------------------------------
        ! LOCAL VARIABLES
        INTEGER :: i !! iteration variable
        !===============================================================================================================================
        ASSOCIATE(vars=>sf%vars)
            CLOSE(vars%logUnit)
            DO i=-1,1
                IF(ALLOCATED(vars%dofs)) CALL vars%dofs(i)%free()
                IF(ALLOCATED(vars%temp_dofs)) CALL vars%temp_dofs(i)%free()
            END DO
            DO i=-1,0
                IF(ALLOCATED(vars%force)) CALL vars%force(i)%free()
            END DO

            SDEALLOCATE(vars%dofs)
            SDEALLOCATE(vars%temp_dofs)
            SDEALLOCATE(vars%force)
            SELECT TYPE(vars)
            TYPE IS(t_accelerated_gradient_descent_vars)
                DO i=-1,1
                    IF(ALLOCATED(vars%velocity)) CALL vars%velocity(i)%free()
                END DO
                SDEALLOCATE(vars%velocity)
                SDEALLOCATE(vars%tau)
            END SELECT !Type
        END ASSOCIATE !vars
        SDEALLOCATE(sf%vars)
    END SUBROUTINE Free_minimizer

END MODULE MODgvec_MHD3D_minimize