target_density.F90

Go to the documentation of this file.

!! Copyright (C) 2002-2006 M. Marques, A. Castro, A. Rubio, G. Bertsch
!!
!! This program is free software; you can redistribute it and/or modify
!! it under the terms of the GNU General Public License as published by
!! the Free Software Foundation; either version 2, or (at your option)
!! any later version.
!!
!! This program is distributed in the hope that it will be useful,
!! but WITHOUT ANY WARRANTY; without even the implied warranty of
!! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
!! GNU General Public License for more details.
!!
!! You should have received a copy of the GNU General Public License
!! along with this program; if not, write to the Free Software
!! Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
!! 02110-1301, USA.
!!
 
#include "global.h"
 
module target_density_oct_m
  use batch_ops_oct_m
  use debug_oct_m
  use density_oct_m
  use derivatives_oct_m
  use electron_space_oct_m
  use global_oct_m
  use grid_oct_m
  use io_oct_m
  use io_function_oct_m
  use ions_oct_m
  use ion_dynamics_oct_m
  use, intrinsic :: iso_fortran_env
  use kpoints_oct_m
  use math_oct_m
  use mesh_oct_m
  use mesh_function_oct_m
  use messages_oct_m
  use namespace_oct_m
  use output_low_oct_m
  use parser_oct_m
  use profiling_oct_m
  use restart_oct_m
  use space_oct_m
  use states_abst_oct_m
  use states_elec_oct_m
  use states_elec_calc_oct_m
  use states_elec_restart_oct_m
  use string_oct_m
  use td_oct_m
  use target_low_oct_m
  use types_oct_m
  use unit_oct_m
  use unit_system_oct_m
 
 
  implicit none
 
  private
  public ::                &
    target_init_density,   &
    target_end_density,    &
    target_j1_density,     &
    target_output_density, &
    target_tdcalc_density, &
    chi_current,           &
    target_chi_density
 
 
contains
 
  ! ----------------------------------------------------------------------
  subroutine target_init_density(gr, kpoints, namespace, space, tg, stin, td, restart)
    type(grid_t),        intent(in)    :: gr
    type(kpoints_t),     intent(in)    :: kpoints
    type(namespace_t),   intent(in)    :: namespace
    class(space_t),      intent(in)    :: space
    type(target_t),      intent(inout) :: tg
    type(states_elec_t), intent(inout) :: stin
    type(td_t),          intent(in)    :: td
    type(restart_t),     intent(inout) :: restart
 
    integer             :: ip, ist, jst, cstr_dim(space%dim), ib, idim, jj, no_constraint, no_ptpair, iqn
    type(block_t)       :: blk
    real(real64)        :: psi_re, psi_im, xx(space%dim), rr, fact, xend, xstart
    real(real64), allocatable  :: xp(:), tmp_box(:, :)
    complex(real64), allocatable  :: rotation_matrix(:, :), psi(:, :)
    type(states_elec_t) :: tmp_st
    character(len=1024) :: expression
 
    push_sub(target_init_density)
 
    message(1) =  'Info: Target is a combination of a density and/or a current functional.'
    call messages_info(1, namespace=namespace)
 
    tg%move_ions = td%ions_dyn%ions_move()
    tg%dt = td%dt
 
    tg%curr_functional = oct_no_curr
    tg%curr_weight = m_zero
    tg%strt_iter_curr_tg = 0
 
    !%Variable OCTTargetDensity
    !%Type string
    !%Section Calculation Modes::Optimal Control
    !%Description
    !% If <tt>OCTTargetOperator = oct_tg_density</tt>, then one must supply the target density
    !% that should be searched for. This one can do by supplying a string through
    !% the variable <tt>OCTTargetDensity</tt>. Alternately, give the special string <tt>"OCTTargetDensityFromState"</tt>
    !% to specify the expression via the block <tt>OCTTargetDensityFromState</tt>.
    !%End
 
    !%Variable OCTTargetDensityFromState
    !%Type block
    !%Default no
    !%Section Calculation Modes::Optimal Control
    !%Description
    !% If <tt>OCTTargetOperator = oct_tg_density</tt>, and <tt>OCTTargetDensity = "OCTTargetDensityFromState"</tt>,
    !% you must specify a <tt>OCTTargetDensityState</tt> block, in order to specify which linear
    !% combination of the states present in <tt>restart/gs</tt> is used to
    !% create the target density.
    !%
    !% The syntax is the same as the <tt>TransformStates</tt> block.
    !%End
 
    if (parse_is_defined(namespace, 'OCTTargetDensity')) then
      tg%density_weight = m_one
      safe_allocate(tg%rho(1:gr%np))
      tg%rho = m_zero
      call parse_variable(namespace, 'OCTTargetDensity', "0", expression)
 
      if (trim(expression) == 'OCTTargetDensityFromState') then
 
        if (parse_block(namespace, 'OCTTargetDensityFromState', blk) == 0) then
          call states_elec_copy(tmp_st, tg%st)
          call states_elec_deallocate_wfns(tmp_st)
          call states_elec_look_and_load(restart, namespace, space, tmp_st, gr, kpoints)
 
          safe_allocate(rotation_matrix(1:tmp_st%nst, 1:tmp_st%nst))
 
          rotation_matrix = diagonal_matrix(tmp_st%nst, m_z1)
 
          do ist = 1, tg%st%nst
            do jst = 1, parse_block_cols(blk, ist - 1)
              call parse_block_cmplx(blk, ist - 1, jst - 1, rotation_matrix(jst, ist))
            end do
          end do
 
          safe_allocate(psi(1:gr%np, 1:tg%st%d%dim))
 
          do iqn = tg%st%d%kpt%start, tg%st%d%kpt%end
 
            if (states_are_real(tg%st)) then
              call states_elec_rotate(tmp_st, namespace, gr, real(rotation_matrix, real64) , iqn)
            else
              call states_elec_rotate(tmp_st, namespace, gr, rotation_matrix, iqn)
            end if
 
            do ist = tg%st%st_start, tg%st%st_end
              call states_elec_get_state(tmp_st, gr, ist, iqn, psi)
              call states_elec_set_state(tg%st, gr, ist, iqn, psi)
            end do
 
          end do
 
          safe_deallocate_a(rotation_matrix)
          safe_deallocate_a(psi)
          call states_elec_end(tmp_st)
 
          call density_calc(tg%st, gr, tg%st%rho)
          do ip = 1, gr%np
            tg%rho(ip) = sum(tg%st%rho(ip, 1:tg%st%d%spin_channels))
          end do
          call parse_block_end(blk)
        else
          call messages_variable_is_block(namespace, 'OCTTargetDensityFromState')
        end if
 
      else
 
        call conv_to_c_string(expression)
        do ip = 1, gr%np
          call mesh_r(gr, ip, rr, coords = xx)
          ! parse user-defined expression
          call parse_expression(psi_re, psi_im, space%dim, xx, rr, m_zero, expression)
          tg%rho(ip) = psi_re
        end do
        ! Normalize
        rr = dmf_integrate(gr, tg%rho)
        tg%rho = (-tg%st%val_charge) * tg%rho/rr
      end if
 
    else
      tg%density_weight = m_zero
    end if
 
    !%Variable OCTCurrentFunctional
    !%Type integer
    !%Section Calculation Modes::Optimal Control
    !%Default oct_no_curr
    !%Description
    !% (Experimental) The variable <tt>OCTCurrentFunctional</tt> describes which kind of
    !% current target functional <math>J1_c[j]</math> is to be used.
    !%Option oct_no_curr 0
    !% No current functional is used, no current calculated.
    !%Option oct_curr_square 1
    !% Calculates the square of current <math>j</math>:
    !% <math>J1_c[j] = {\tt OCTCurrentWeight} \int{\left| j(r) \right|^2 dr}</math>.
    !% For <tt>OCTCurrentWeight</tt> < 0, the current will be minimized (useful in combination with
    !% target density in order to obtain stable final target density), while for
    !% <tt>OCTCurrentWeight</tt> > 0, it will be maximized (useful in combination with a target density
    !% in order to obtain a high-velocity impact, for instance). It is a static target, to be reached at
    !% total time.
    !%Option oct_max_curr_ring 2
    !% Maximizes the current of a quantum ring in one direction. The functional maximizes the <math>z</math> projection of the
    !% outer product between the position <math>\vec{r}</math> and the current <math>\vec{j}</math>:
    !% <math>J1[j] = {\tt OCTCurrentWeight} \int{(\vec{r} \times \vec{j}) \cdot \hat{z} dr}</math>.
    !% For <tt>OCTCurrentWeight</tt> > 0, the
    !% current flows in counter-clockwise direction, while for <tt>OCTCurrentWeight</tt> < 0, the current is clockwise.
    !%Option oct_curr_square_td 3
    !% The time-dependent version of <tt>oct_curr_square</tt>. In fact, calculates the
    !% square of current in time interval [<tt>OCTStartTimeCurrTg</tt>,
    !% total time = <tt>TDMaximumIter</tt> * <tt>TDTimeStep</tt>].
    !% Set <tt>TDPropagator</tt> = <tt>crank_nicolson</tt>.
    !%End
 
    !%Variable OCTCurrentWeight
    !%Type float
    !%Section Calculation Modes::Optimal Control
    !%Default 0.0
    !%Description
    !% In the case of simultaneous optimization of density <math>n</math> and current <math>j</math>, one can tune the importance
    !% of the current functional <math>J1_c[j]</math>, as the respective functionals might not provide results on the
    !% same scale of magnitude. <math>J1[n,j]= J1_d[n]+ {\tt OCTCurrentWeight}\ J1_c[j]</math>. Be aware that its
    !% sign is crucial for the chosen <tt>OCTCurrentFunctional</tt> as explained there.
    !%End
 
    !%Variable OCTStartIterCurrTg
    !%Type integer
    !%Section Calculation Modes::Optimal Control
    !%Default 0
    !%Description
    !% Allows for a time-dependent target for the current without defining it for the total
    !% time-interval of the simulation.
    !% Thus it can be switched on at the iteration desired, <tt>OCTStartIterCurrTg</tt> >= 0
    !% and  <tt>OCTStartIterCurrTg</tt>  <  <tt>TDMaximumIter</tt>.
    !% Tip: If you would like to specify a real time for switching
    !% the functional on rather than the number of steps, just use something
    !% like:
    !% <tt>OCTStartIterCurrTg</tt> = 100.0 / <tt>TDTimeStep</tt>.
    !%End
 
    !%Variable OCTSpatialCurrWeight
    !%Type block
    !%Section Calculation Modes::Optimal Control
    !%Description
    !% Can be seen as a position-dependent <tt>OCTCurrentWeight</tt>. Consequently, it
    !% weights contribution of current <math>j</math> to its functional <math>J1_c[j]</math> according to the position in space.
    !% For example, <tt>oct_curr_square</tt> thus becomes
    !% <math>J1_c[j] = {\tt OCTCurrentWeight} \int{\left| j(r) \right|^2 {\tt OCTSpatialCurrWeight}(r) dr}</math>.
    !%
    !% It is defined as <tt>OCTSpatialCurrWeight</tt><math>(r) = g(x) g(y) g(z)</math>, where
    !% <math>g(x) = \sum_{i} 1/(1+e^{-{\tt fact} (x-{\tt startpoint}_i)}) - 1/(1+e^{-{\tt fact} (x-{\tt endpoint}_i)})</math>.
    !% If not specified, <math>g(x) = 1</math>.
    !%
    !% Each <math>g(x)</math> is represented by one line of the block that has the following form
    !%
    !% <tt>%OCTSpatialCurrWeight
    !% <br>&nbsp;&nbsp;  dimension  |  fact |  startpoint_1  | endpoint_1  | startpoint_2 | endpoint_2 |...
    !% <br>%</tt>
    !%
    !% There are no restrictions on the number of lines, nor on the number of pairs of start- and endpoints.
    !% Attention: <tt>startpoint</tt> and <tt>endpoint</tt> have to be supplied pairwise
    !% with <tt>startpoint  <  endpoint</tt>. <tt>dimension > 0</tt> is integer, <tt>fact</tt> is float.
    !%End
 
    call parse_variable(namespace, 'OCTCurrentFunctional', oct_no_curr, tg%curr_functional)
    select case (tg%curr_functional)
    case (oct_no_curr)
    case (oct_curr_square, oct_max_curr_ring, oct_curr_square_td)
      if (.not. allocated(stin%current)) then
        safe_allocate(stin%current( 1:gr%np_part, 1:space%dim, 1:stin%d%nspin))
        stin%current= m_zero
      end if
    end select
 
    call parse_variable(namespace, 'OCTCurrentWeight', m_zero, tg%curr_weight)
    write(message(1), '(a,i3)')   'Info: OCTCurrentFunctional = ', tg%curr_functional
    write(message(2), '(a,f8.3)') 'Info: OCTCurrentWeight = ',  tg%curr_weight
    call messages_info(2, namespace=namespace)
 
    if (target_mode(tg) == oct_targetmode_td) then
      call parse_variable(namespace, 'OCTStartIterCurrTg', 0, tg%strt_iter_curr_tg)
      if (tg%strt_iter_curr_tg  <  0) then
        call messages_input_error(namespace, 'OCTStartIterCurrTg', 'Must be positive.')
      elseif (tg%strt_iter_curr_tg >= td%max_iter) then
        call messages_input_error(namespace, 'OCTStartIterCurrTg', 'Has to be  <  TDMaximumIter.')
      end if
      write(message(1), '(a,i3)')   'Info: TargetMode = ', target_mode(tg)
      write(message(2), '(a,i8)') 'Info: OCTStartIterCurrTg = ',  tg%strt_iter_curr_tg
      call messages_info(2, namespace=namespace)
      tg%dt = td%dt
      safe_allocate(tg%td_fitness(0:td%max_iter))
      tg%td_fitness = m_zero
    else
      tg%strt_iter_curr_tg = 0
    end if
 
    if (parse_is_defined(namespace, 'OCTSpatialCurrWeight')) then
      if (parse_block(namespace, 'OCTSpatialCurrWeight', blk) == 0) then
        safe_allocate(tg%spatial_curr_wgt(1:gr%np_part))
        safe_allocate(xp(1:gr%np_part))
        safe_allocate(tmp_box(1:gr%np_part, 1:space%dim))
 
        no_constraint = parse_block_n(blk)
        tmp_box = m_zero
        cstr_dim = 0
        do ib = 1, no_constraint
          call parse_block_integer(blk, ib - 1, 0, idim)
          if (idim  <=  0 .or. idim > space%dim) then
            write(message(1), '(a,i3)') 'Error in "OCTSpatialCurrWeight" block, line:', ib
            write(message(2), '(a)'   ) '"dimension" has to be positive'
            write(message(3), '(a)'   ) 'and must not exceed dimensions of the system.'
            call messages_fatal(3, namespace=namespace)
          end if
          cstr_dim(idim) = 1
          xp(1:gr%np_part) = gr%x(1:gr%np_part, idim)
 
          call parse_block_float(blk, ib - 1, 1, fact)
 
          no_ptpair = parse_block_cols(blk, ib-1) - 2
          if (mod(no_ptpair,2) /= 0) then
            write(message(1), '(a,i3)') 'Error in "OCTSpatialCurrWeight" block, line:', ib
            write(message(2), '(a)'   ) 'Each interval needs start and end point!'
            call messages_fatal(2, namespace=namespace)
          end if
 
          do jj= 2, no_ptpair, 2
            call parse_block_float(blk, ib - 1, jj, xstart)
            call parse_block_float(blk, ib - 1, jj+1, xend)
 
            if (xstart >= xend) then
              write(message(1), '(a,i3)') 'Error in "OCTSpatialCurrWeight" block, line:', ib
              write(message(2), '(a)'   ) 'Set "startpoint"  <  "endpoint" '
              call messages_fatal(2, namespace=namespace)
            end if
 
            do ip = 1, gr%np_part
              tmp_box(ip,idim) = tmp_box(ip,idim) + m_one/(m_one+exp(-fact*(xp(ip)-xstart))) -  &
                m_one/(m_one+exp(-fact*(xp(ip)-xend)))
            end do
          end do
 
        end do
 
        do idim = 1, space%dim
          if (cstr_dim(idim) == 0) tmp_box(:,idim) = m_one
        end do
        tg%spatial_curr_wgt(1:gr%np_part) = product(tmp_box(1:gr%np_part, 1:space%dim),2)
        safe_deallocate_a(xp)
        safe_deallocate_a(tmp_box)
 
        call parse_block_end(blk)
      else
        call messages_input_error(namespace, 'OCTSpatialCurrWeight', 'Has to be specified as a block.')
      end if
    end if
 
    pop_sub(target_init_density)
  end subroutine target_init_density
 
 
  ! ----------------------------------------------------------------------
  subroutine target_end_density(tg)
    type(target_t),   intent(inout) :: tg
 
    push_sub(target_end_density)
 
    safe_deallocate_a(tg%rho)
    safe_deallocate_a(tg%spatial_curr_wgt)
    select case (tg%curr_functional)
    case (oct_curr_square_td)
      safe_deallocate_a(tg%td_fitness)
    end select
 
    pop_sub(target_end_density)
  end subroutine target_end_density
 
 
  ! ----------------------------------------------------------------------
  subroutine target_output_density(tg, namespace, space, mesh, dir, ions, outp)
    type(target_t),    intent(in) :: tg
    type(namespace_t), intent(in) :: namespace
    class(space_t),    intent(in) :: space
    class(mesh_t),     intent(in) :: mesh
    character(len=*),  intent(in) :: dir
    type(ions_t),      intent(in) :: ions
    type(output_t),    intent(in) :: outp
 
    integer :: ierr
    push_sub(target_output_density)
 
    call io_mkdir(trim(dir), namespace)
 
    if (tg%density_weight > m_zero) then
      call dio_function_output(outp%how(0), trim(dir), 'density_target', namespace, space, mesh, &
        tg%rho, units_out%length**(-space%dim), ierr, pos=ions%pos, atoms=ions%atom)
    end if
 
 
    pop_sub(target_output_density)
  end subroutine target_output_density
  ! ----------------------------------------------------------------------
 
 
  ! ----------------------------------------------------------------------
  real(real64) function target_j1_density(gr, kpoints, tg, psi) result(j1)
    type(grid_t),        intent(in)    :: gr
    type(kpoints_t),     intent(in)    :: kpoints
    type(target_t),      intent(in)    :: tg
    type(states_elec_t), intent(inout) :: psi
 
    integer :: ip, maxiter
    real(real64) :: currfunc_tmp
    real(real64), allocatable :: local_function(:)
 
    push_sub(target_j1_density)
 
    if (tg%density_weight > m_zero) then
      safe_allocate(local_function(1:gr%np))
      do ip = 1, gr%np
        local_function(ip) = - ( sqrt(psi%rho(ip, 1)) - sqrt(tg%rho(ip)) )**2
      end do
      j1 = tg%density_weight * dmf_integrate(gr, local_function)
      safe_deallocate_a(local_function)
    else
      j1 = m_zero
    end if
 
    ! current functionals are conveniently combined with others
    if (tg%curr_functional /= oct_no_curr) then
      select case (target_mode(tg))
      case (oct_targetmode_static)
        currfunc_tmp = jcurr_functional(tg, gr, kpoints, psi)
      case (oct_targetmode_td)
        maxiter = size(tg%td_fitness) - 1
        currfunc_tmp = m_half * tg%dt * tg%td_fitness(tg%strt_iter_curr_tg) + &
          m_half * tg%dt * tg%td_fitness(maxiter) + &
          tg%dt * sum(tg%td_fitness(tg%strt_iter_curr_tg+1:maxiter-1))
      end select
      if (conf%devel_version) then
        write(message(1), '(6x,a,f12.5)')    " => Other functional   = ", j1
        write(message(2), '(6x,a,f12.5)')    " => Current functional = ", currfunc_tmp
        call messages_info(2)
      end if
      ! accumulating functional values
      j1 = j1 + currfunc_tmp
    end if
 
    pop_sub(target_j1_density)
  end function target_j1_density
 
 
  ! ----------------------------------------------------------------------
  subroutine target_chi_density(tg, gr, kpoints, psi_in, chi_out)
    type(target_t),      intent(in)    :: tg
    type(grid_t),        intent(in)    :: gr
    type(kpoints_t),     intent(in)    :: kpoints
    type(states_elec_t), intent(inout) :: psi_in
    type(states_elec_t), intent(inout) :: chi_out
 
    integer :: no_electrons, ip, ist, ib, ik
    complex(real64), allocatable :: zpsi(:, :)
 
    push_sub(target_chi_density)
 
    do ik = chi_out%d%kpt%start, chi_out%d%kpt%end
      do ib = chi_out%group%block_start, chi_out%group%block_end
        call batch_set_zero(chi_out%group%psib(ib, ik))
      end do
    end do
 
    no_electrons = -nint(psi_in%val_charge)
 
    if (tg%density_weight > m_zero) then
 
      select case (psi_in%d%ispin)
      case (unpolarized)
        assert(psi_in%nik == 1)
 
        safe_allocate(zpsi(1:gr%np, 1))
 
        if (no_electrons == 1) then
 
          call states_elec_get_state(psi_in, gr, 1, 1, zpsi)
 
          do ip = 1, gr%np
            zpsi(ip, 1) = sqrt(tg%rho(ip))*exp(m_zi*atan2(aimag(zpsi(ip, 1)), real(zpsi(ip, 1),real64) ))
          end do
 
          call states_elec_set_state(chi_out, gr, 1, 1, zpsi)
 
        else
          do ist = psi_in%st_start, psi_in%st_end
 
            call states_elec_get_state(psi_in, gr, ist, 1, zpsi)
 
            do ip = 1, gr%np
              if (psi_in%rho(ip, 1) > 1.0e-8_real64) then
                zpsi(ip, 1) = psi_in%occ(ist, 1)*sqrt(tg%rho(ip)/psi_in%rho(ip, 1))*zpsi(ip, 1)
              else
                zpsi(ip, 1) = m_zero !sqrt(tg%rho(ip))
              end if
            end do
 
            call states_elec_set_state(chi_out, gr, ist, 1, zpsi)
 
          end do
        end if
 
      case (spin_polarized)
        message(1) = 'Error in target.target_chi_density: spin_polarized.'
        call messages_fatal(1)
      case (spinors)
        message(1) = 'Error in target.target_chi_density: spinors.'
        call messages_fatal(1)
      end select
 
    end if
 
    if (tg%curr_functional /= oct_no_curr) then
      if (target_mode(tg) == oct_targetmode_static) then
        call chi_current(tg, gr, kpoints, m_one, psi_in, chi_out)
      end if
    end if
 
    pop_sub(target_chi_density)
  end subroutine target_chi_density
 
 
  ! ---------------------------------------------------------
  subroutine target_tdcalc_density(tg, gr, kpoints, psi, time)
    type(target_t),      intent(inout) :: tg
    type(grid_t),        intent(in)    :: gr
    type(kpoints_t),     intent(in)    :: kpoints
    type(states_elec_t), intent(inout) :: psi
    integer,             intent(in)    :: time
 
    push_sub(target_tdcalc_density)
 
    if (time >= tg%strt_iter_curr_tg) then
      tg%td_fitness(time) = jcurr_functional(tg, gr, kpoints, psi)
    end if
 
 
    pop_sub(target_tdcalc_density)
  end subroutine target_tdcalc_density
  ! ----------------------------------------------------------------------
 
 
  ! ----------------------------------------------------------------------
  real(real64) function jcurr_functional(tg, gr, kpoints, psi) result(jcurr)
    type(target_t),      intent(in)    :: tg
    type(grid_t),        intent(in)    :: gr
    type(kpoints_t),     intent(in)    :: kpoints
    type(states_elec_t), intent(inout) :: psi
 
    integer :: ip
    real(real64), allocatable :: semilocal_function(:)
 
    push_sub(jcurr_functional)
 
    jcurr = m_zero
    assert(psi%nik == 1)
    safe_allocate(semilocal_function(1:gr%np))
    semilocal_function = m_zero
 
    select case (tg%curr_functional)
    case (oct_no_curr)
      semilocal_function = m_zero
 
    case (oct_curr_square,oct_curr_square_td)
      call states_elec_calc_quantities(gr, psi, kpoints, .false., paramagnetic_current=psi%current)
      do ip = 1, gr%np
        semilocal_function(ip) =  sum(psi%current(ip, 1:gr%box%dim, 1)**2)
      end do
 
    case (oct_max_curr_ring)
      call states_elec_calc_quantities(gr, psi, kpoints, .false., paramagnetic_current=psi%current)
 
      if (gr%box%dim /= 2) then
        call messages_not_implemented('Target for dimension != 2')
      end if
 
      do ip = 1, gr%np
        ! func = j_y * x - j_x * y
        semilocal_function(ip) = psi%current(ip, 2, 1) *  gr%x(ip,1) -  &
          psi%current(ip, 1, 1) * gr%x(ip,2)
      end do
    case default
      message(1) = 'Error in target.jcurr_functional: chosen target does not exist'
      call messages_fatal(1)
    end select
 
 
    if (is_spatial_curr_wgt(tg)) then
      do ip = 1, gr%np
        semilocal_function(ip) = semilocal_function(ip) * tg%spatial_curr_wgt(ip)
      end do
    end if
 
    jcurr = tg%curr_weight * dmf_integrate(gr, semilocal_function)
 
    safe_deallocate_a(semilocal_function)
 
    pop_sub(jcurr_functional)
  end function jcurr_functional
  !-----------------------------------------------------------------------
 
  ! ----------------------------------------------------------------------
  ! Calculates current-specific boundary condition
  !-----------------------------------------------------------------------
  subroutine chi_current(tg, gr, kpoints, factor, psi_in, chi)
    type(target_t),       intent(in)    :: tg
    type(grid_t),         intent(in)    :: gr
    type(kpoints_t),      intent(in)    :: kpoints
    real(real64),         intent(in)    :: factor
    type(states_elec_t),  intent(inout) :: psi_in
    type(states_elec_t),  intent(inout) :: chi
 
    complex(real64), allocatable :: grad_psi_in(:,:,:), zpsi(:, :), zchi(:, :)
    real(real64), allocatable :: div_curr_psi_in(:,:)
    integer :: ip, ist, idim
 
    push_sub(chi_current)
    safe_allocate(grad_psi_in(1:gr%np_part, 1:gr%box%dim, 1))
 
    if (target_mode(tg) == oct_targetmode_td) then
      call states_elec_calc_quantities(gr, psi_in, kpoints, .false., paramagnetic_current=psi_in%current)
    end if
 
    select case (tg%curr_functional)
    case (oct_no_curr)
      !nothing to do
 
    case (oct_curr_square,oct_curr_square_td)
      ! components current weighted by its position in the mesh, np_part included,
      ! since needed for the divergence of current.
      if (is_spatial_curr_wgt(tg)) then
        do idim = 1, gr%box%dim
          do ip = 1, gr%np_part
            psi_in%current(ip, idim, 1) = psi_in%current(ip, idim, 1) * tg%spatial_curr_wgt(ip)
          end do
        end do
      end if
 
      safe_allocate(div_curr_psi_in(1:gr%np_part, 1))
      safe_allocate(zpsi(1:gr%np_part, 1:psi_in%d%dim))
      safe_allocate(zchi(1:gr%np_part, 1:psi_in%d%dim))
 
      call dderivatives_div(gr%der, psi_in%current(:, :, 1), div_curr_psi_in(:,1))
 
      ! the boundary condition
      do ist = psi_in%st_start, psi_in%st_end
 
        call states_elec_get_state(psi_in, gr, ist, 1, zpsi)
        call states_elec_get_state(chi, gr, ist, 1, zchi)
 
        call zderivatives_grad(gr%der, zpsi(:, 1), grad_psi_in(:, :, 1))
 
        do idim = 1, psi_in%d%dim
          do ip = 1, gr%np
            zchi(ip, idim) = zchi(ip, idim) - factor*m_zi*tg%curr_weight* &
              (m_two*sum(psi_in%current(ip, 1:gr%box%dim, 1)*grad_psi_in(ip, 1:gr%box%dim, 1)) + &
              div_curr_psi_in(ip, 1)*zpsi(ip, idim))
          end do
        end do
 
        call states_elec_set_state(chi, gr, ist, 1, zchi)
 
      end do
 
      safe_deallocate_a(div_curr_psi_in)
      safe_deallocate_a(zpsi)
      safe_deallocate_a(zchi)
 
    case (oct_max_curr_ring)
 
      safe_allocate(zpsi(1:gr%np_part, 1:psi_in%d%dim))
      safe_allocate(zchi(1:gr%np_part, 1:psi_in%d%dim))
 
      do ist = psi_in%st_start, psi_in%st_end
 
        call states_elec_get_state(psi_in, gr, ist, 1, zpsi)
        call states_elec_get_state(chi, gr, ist, 1, zchi)
 
        call zderivatives_grad(gr%der, zpsi(:, 1), grad_psi_in(:, :, 1))
 
        if (is_spatial_curr_wgt(tg)) then
 
          do ip = 1, gr%np
            zchi(ip, 1) = zchi(ip, 1) + factor*m_zi*tg%curr_weight*tg%spatial_curr_wgt(ip)* &
              (grad_psi_in(ip, 1, 1)*gr%x(ip,2) - grad_psi_in(ip, 2, 1)*gr%x(ip, 1))
          end do
 
        else
 
          do ip = 1, gr%np
            zchi(ip, 1) = zchi(ip, 1) + factor*m_zi*tg%curr_weight* &
              (grad_psi_in(ip, 1, 1)*gr%x(ip,2) - grad_psi_in(ip, 2, 1)*gr%x(ip, 1))
          end do
 
        end if
 
        call states_elec_set_state(chi, gr, ist, 1, zchi)
 
      end do
 
      safe_deallocate_a(zpsi)
      safe_deallocate_a(zchi)
 
    case default
      message(1) = 'Error in target.chi_current: chosen target does not exist'
      call messages_fatal(1)
    end select
 
    safe_deallocate_a(grad_psi_in)
    pop_sub(chi_current)
  end subroutine chi_current
  ! ----------------------------------------------------------------------
 
end module target_density_oct_m
 
!! Local Variables:
!! mode: f90
!! coding: utf-8
!! End: