! $Id: noinitial_condition.f90 14462 2010-07-28 20:14:46Z wladimir.lyra $
!
! This module provide a way for users to specify custom initial
! conditions.
!
! The module provides a set of standard hooks into the Pencil Code
! and currently allows the following customizations:
!
! Description | Relevant function call
! ------------------------------------------------------------------------
! Initial condition registration | register_special
! (pre parameter read) |
! Initial condition initialization | initialize_special
! (post parameter read) |
! |
! Initial condition for momentum | initial_condition_uu
! Initial condition for density | initial_condition_lnrho
! Initial condition for entropy | initial_condition_ss
! Initial condition for magnetic potential | initial_condition_aa
!
! And a similar subroutine for each module with an "init_XXX" call.
! The subroutines are organized IN THE SAME ORDER THAT THEY ARE CALLED.
! First uu, then lnrho, then ss, then aa, and so on.
!
!** AUTOMATIC CPARAM.INC GENERATION ****************************
! Declare (for generation of cparam.inc) the number of f array
! variables and auxiliary variables added by this module
!
! CPARAM logical, parameter :: linitial_condition = .true.
!
!***************************************************************
!
! HOW TO USE THIS FILE
! --------------------
!
! Change the line above to
! linitial_condition = .true.
! to enable use of custom initial conditions.
!
! The rest of this file may be used as a template for your own initial
! conditions. Simply fill out the prototypes for the features you want
! to use.
!
! Save the file with a meaningful name, e.g. mhs_equilibrium.f90, and
! place it in the $PENCIL_HOME/src/initial_condition directory. This
! path has been created to allow users to optionally check their
! contributions in to the Pencil Code SVN repository. This may be
! useful if you are working on/using an initial condition with
! somebody else or may require some assistance from one from the main
! Pencil Code team. HOWEVER, less general initial conditions should
! not go here (see below).
!
! You can also place initial condition files directly in the run
! directory. Simply create the folder 'initial_condition' at the same
! level as the *.in files and place an initial condition file there.
! With pc_setupsrc this file is linked automatically into the local
! src directory. This is the preferred method for initial conditions
! that are not very general.
!
! To use your additional initial condition code, edit the
! Makefile.local in the src directory under the run directory in which
! you wish to use your initial condition. Add a line that says e.g.
!
! INITIAL_CONDITION = initial_condition/mhs_equilibrium
!
! Here mhs_equilibrium is replaced by the filename of your new file,
! not including the .f90 extension.
!
! This module is based on Tony's special module.
!
module InitialCondition
!
use Cdata
use Cparam
use Messages
use General, only: keep_compiler_quiet
!
implicit none
!
include 'initial_condition.h'
!
!! integer :: dummy
!
!! namelist /initial_condition_pars/ dummy
!
contains
!***********************************************************************
subroutine register_initial_condition()
!
! Register variables associated with this module; likely none.
!
! 07-may-09/wlad: coded
!
if (lroot) call svn_id( &
"$Id: noinitial_condition.f90 14462 2010-07-28 20:14:46Z wladimir.lyra $")
!
endsubroutine register_initial_condition
!***********************************************************************
subroutine initialize_initial_condition(f)
!
! Initialize any module variables which are parameter dependent.
!
! 07-may-09/wlad: coded
!
real, dimension (mx,my,mz,mfarray) :: f
!
call keep_compiler_quiet(f)
!
endsubroutine initialize_initial_condition
!***********************************************************************
subroutine initial_condition_uu(f)
!
! Initialize the velocity field.
!
! 07-may-09/wlad: coded
!
real, dimension (mx,my,mz,mfarray), intent(inout) :: f
!
! SAMPLE IMPLEMENTATION
!
call keep_compiler_quiet(f)
!
endsubroutine initial_condition_uu
!***********************************************************************
subroutine initial_condition_lnrho(f)
!
! Initialize logarithmic density. init_lnrho will take care of
! converting it to linear density if you use ldensity_nolog.
!
! 07-may-09/wlad: coded
!
real, dimension (mx,my,mz,mfarray), intent(inout) :: f
!
! SAMPLE IMPLEMENTATION
!
call keep_compiler_quiet(f)
!
endsubroutine initial_condition_lnrho
!***********************************************************************
subroutine initial_condition_ss(f)
!
! Initialize entropy.
!
! 07-may-09/wlad: coded
!
real, dimension (mx,my,mz,mfarray), intent(inout) :: f
!
! SAMPLE IMPLEMENTATION
!
call keep_compiler_quiet(f)
!
endsubroutine initial_condition_ss
!***********************************************************************
subroutine initial_condition_aa(f)
!
! Initialize the magnetic vector potential.
!
! 07-may-09/wlad: coded
!
use Poisson
!
real, dimension (mx,my,mz,mfarray), intent(inout) :: f
real, dimension (nx,ny,nz,3) :: jj
real, dimension (nx,ny,nz) :: phi
integer :: j,ju
!
do m=1,ny; do n=1,nz
do j=1,3
jj(:,m,n,j) = sin(2*pi*x(l1:l2)/Lxyz(1))
enddo
enddo; enddo
!
! Feed J into the inverse laplacian
!
do j=1,3
ju=iaa-1+j
phi =-jj(:,:,:,j)
call inverse_laplacian(f,phi)
f(l1:l2,m1:m2,n1:n2,ju)=phi
enddo
!
endsubroutine initial_condition_aa
!***********************************************************************
subroutine read_initial_condition_pars(unit,iostat)
!
! 07-may-09/wlad: coded
!
integer, intent(in) :: unit
integer, intent(inout), optional :: iostat
!
call keep_compiler_quiet(unit)
if (present(iostat)) call keep_compiler_quiet(iostat)
!
endsubroutine read_initial_condition_pars
!***********************************************************************
subroutine write_initial_condition_pars(unit)
!
! 07-may-09/wlad: coded
!
integer, intent(in) :: unit
!
call keep_compiler_quiet(unit)
!
endsubroutine write_initial_condition_pars
!***********************************************************************
!
!********************************************************************
!************ DO NOT DELETE THE FOLLOWING **************
!********************************************************************
!** This is an automatically generated include file that creates **
!** copies dummy routines from noinitial_condition.f90 for any **
!** InitialCondition routines not implemented in this file **
!** **
include 'initial_condition_dummies.inc'
!********************************************************************
endmodule InitialCondition