[header-bot] updated file headers

danieljprice · Jul 28, 2020 · 5c5f8f0 · 5c5f8f0
1 parent dbbcb92
commit 5c5f8f0
Show file tree

Hide file tree

Showing 28 changed files with 68 additions and 83 deletions.
diff --git a/src/main/checkconserved.f90 b/src/main/checkconserved.f90
@@ -15,7 +15,7 @@ module checkconserved
 !
 ! :Runtime parameters: None
 !
-! :Dependencies:
+! :Dependencies: dim, externalforces, io, options, part
 !
  use dim, only:maxdusttypes
  implicit none

diff --git a/src/main/evolve.F90 b/src/main/evolve.F90
@@ -16,9 +16,9 @@ module evolve
 !
 ! :Runtime parameters: None
 !
-! :Dependencies: analysis, centreofmass, derivutils, dim, energies,
-!   evwrite, externalforces, fileutils, forcing, inject,
-!   io, io_summary, mf_write, mpiutils, options, part, partinject, ptmass,
+! :Dependencies: analysis, centreofmass, checkconserved, derivutils, dim,
+!   energies, evwrite, externalforces, fileutils, forcing, inject, io,
+!   io_summary, mf_write, mpiutils, options, part, partinject, ptmass,
 !   quitdump, radiation_utils, readwrite_dumps, readwrite_infile,
 !   step_lf_global, supertimestep, timestep, timestep_ind, timestep_sts,
 !   timing

diff --git a/src/main/growth.F90 b/src/main/growth.F90
@@ -29,7 +29,7 @@ module growth
 !   - vfragout      : *inward fragmentation threshold in m/s*
 !   - wbymass       : *weight dustgasprops by mass rather than mass/density*
 !
-! :Dependencies: dim, dust, eos, infile_utils, io, options,
+! :Dependencies: checkconserved, dim, dust, eos, infile_utils, io, options,
 !   part, physcon, table_utils, units, viscosity
 !
  use units,        only:udist,unit_density,unit_velocity

diff --git a/src/main/initial.F90 b/src/main/initial.F90
@@ -14,15 +14,15 @@ module initial
 !
 ! :Runtime parameters: None
 !
-! :Dependencies: analysis, balance, boundary, centreofmass, checkoptions,
-!   checksetup, chem, cons2prim, cooling, cpuinfo, densityforce, deriv,
-!   dim, domain, dust, energies, eos, evwrite, extern_gr, externalforces,
-!   fastmath, fileutils, forcing, growth, h2cooling,
-!   inject, io, io_summary, krome_interface, linklist, metric_tools,
-!   mf_write, mpi, mpiderivs, mpiutils, nicil, nicil_sup, omputils,
-!   options, part, photoevap, ptmass, readwrite_dumps, readwrite_infile,
-!   sort_particles, stack, timestep, timestep_ind, timestep_sts, timing,
-!   units, writeheader
+! :Dependencies: analysis, balance, boundary, centreofmass, checkconserved,
+!   checkoptions, checksetup, chem, cons2prim, cooling, cpuinfo,
+!   densityforce, deriv, dim, domain, dust, energies, eos, evwrite,
+!   extern_gr, externalforces, fastmath, fileutils, forcing, growth,
+!   h2cooling, inject, io, io_summary, krome_interface, linklist,
+!   metric_tools, mf_write, mpi, mpiderivs, mpiutils, nicil, nicil_sup,
+!   omputils, options, part, photoevap, ptmass, readwrite_dumps,
+!   readwrite_infile, sort_particles, stack, timestep, timestep_ind,
+!   timestep_sts, timing, units, writeheader
 !
 #ifdef MPI
  use mpi

diff --git a/src/main/inject_wind.F90 b/src/main/inject_wind.F90
@@ -10,7 +10,7 @@ module inject
 !
 ! :References: None
 !
-! :Owner: Lionel
+! :Owner: Lionel Siess
 !
 ! :Runtime parameters:
 !   - iboundary_spheres  : *number of boundary spheres (integer)*

diff --git a/src/main/kernel_WendlandC2.f90 b/src/main/kernel_WendlandC2.f90
@@ -16,8 +16,6 @@ module kernel
 ! :Runtime parameters: None
 !
 ! :Dependencies: physcon
-!
-! :Generated: 2014-11-20 11:03:54.085594
 !
  use physcon, only:pi
  implicit none

diff --git a/src/main/kernel_WendlandC4.f90 b/src/main/kernel_WendlandC4.f90
@@ -16,8 +16,6 @@ module kernel
 ! :Runtime parameters: None
 !
 ! :Dependencies: physcon
-!
-! :Generated: 2014-11-20 11:03:46.391476
 !
  use physcon, only:pi
  implicit none

diff --git a/src/main/kernel_WendlandC6.f90 b/src/main/kernel_WendlandC6.f90
@@ -16,8 +16,6 @@ module kernel
 ! :Runtime parameters: None
 !
 ! :Dependencies: physcon
-!
-! :Generated: 2014-11-20 11:03:36.858610
 !
  use physcon, only:pi
  implicit none

diff --git a/src/main/kernel_cubic.f90 b/src/main/kernel_cubic.f90
@@ -16,8 +16,6 @@ module kernel
 ! :Runtime parameters: None
 !
 ! :Dependencies: physcon
-!
-! :Generated: 2014-11-20 11:18:12.618733
 !
  use physcon, only:pi
  implicit none

diff --git a/src/main/kernel_quartic.f90 b/src/main/kernel_quartic.f90
@@ -16,8 +16,6 @@ module kernel
 ! :Runtime parameters: None
 !
 ! :Dependencies: physcon
-!
-! :Generated: 2017-02-13 00:47:58.677164
 !
  use physcon, only:pi
  implicit none

diff --git a/src/main/kernel_quintic.f90 b/src/main/kernel_quintic.f90
@@ -16,8 +16,6 @@ module kernel
 ! :Runtime parameters: None
 !
 ! :Dependencies: physcon
-!
-! :Generated: 2014-11-20 11:03:06.568115
 !
  use physcon, only:pi
  implicit none

diff --git a/src/main/krome.f90 b/src/main/krome.f90
@@ -11,7 +11,7 @@ module krome_interface
 !
 ! :References: None
 !
-! :Owner: ward
+! :Owner: Lionel
 !
 ! :Runtime parameters: None
 !

diff --git a/src/main/options.f90 b/src/main/options.f90
@@ -18,7 +18,6 @@ module options
 !
 ! :Dependencies: dim, eos, kernel, part, timestep, units, viscosity
 !
- use eos, only:ieos ! so this is available via options module
  implicit none
  character(len=80), parameter, public :: &  ! module version
     modid="$Id$"

diff --git a/src/main/readwrite_dumps.F90 b/src/main/readwrite_dumps.F90
@@ -18,9 +18,10 @@ module readwrite_dumps
 !
 ! :Runtime parameters: None
 !
-! :Dependencies: boundary, dim, dump_utils, eos, externalforces, fileutils,
-!   gitinfo, io, krome_user, lumin_nsdisc, memory, mpi,
-!   mpiutils, options, part, setup_params, sphNGutils, timestep, units
+! :Dependencies: boundary, checkconserved, dim, dump_utils, eos,
+!   externalforces, fileutils, gitinfo, io, krome_user, lumin_nsdisc,
+!   memory, mpi, mpiutils, options, part, setup_params, sphNGutils,
+!   timestep, units
 !
  use dump_utils, only:lenid,ndatatypes,i_int,i_int1,i_int2,i_int4,i_int8,&
                       i_real,i_real4,i_real8,int1,int2,int1o,int2o,dump_h,lentag

diff --git a/src/main/readwrite_dumps_hdf5.F90 b/src/main/readwrite_dumps_hdf5.F90
@@ -18,8 +18,8 @@ module readwrite_dumps
 !
 ! :Runtime parameters: None
 !
-! :Dependencies: boundary, dim, eos, extern_binary, extern_gwinspiral,
-!   externalforces, gitinfo, io, lumin_nsdisc, memory,
+! :Dependencies: boundary, checkconserved, dim, eos, extern_binary,
+!   extern_gwinspiral, externalforces, gitinfo, io, lumin_nsdisc, memory,
 !   mpiutils, options, part, setup_params, timestep, units,
 !   utils_dumpfiles_hdf5
 !

diff --git a/src/setup/set_fixedentropycore.f90 b/src/setup/set_fixedentropycore.f90
@@ -4,26 +4,20 @@
 ! See LICENCE file for usage and distribution conditions                   !
 ! http://phantomsph.bitbucket.io/                                          !
 !--------------------------------------------------------------------------!
-!+
-!  MODULE: setfixedentropycore
+module setfixedentropycore
 !
-!  DESCRIPTION:
-!   This module softens the core of a MESA stellar profile with a constant
+! This module softens the core of a MESA stellar profile with a constant
 !   entropy profile, given a softening length and core mass, in preparation
 !   for adding a sink particle core.
 !
-!  REFERENCES:
+! :References:
 !
-!  OWNER: Mike Lau
+! :Owner: Mike Lau
 !
-!  $Id$
+! :Runtime parameters: None
 !
-!  RUNTIME PARAMETERS: None
+! :Dependencies: eos, kernel, physcon, table_utils
 !
-!  DEPENDENCIES: eos, kernel, physcon, table_utils
-!+
-!--------------------------------------------------------------------------
-module setfixedentropycore
  implicit none
 
 contains

diff --git a/src/setup/set_softened_core.f90 b/src/setup/set_softened_core.f90
@@ -17,7 +17,7 @@ module setsoftenedcore
 !
 ! :Runtime parameters: None
 !
-! :Dependencies: eos, physcon, table_utils
+! :Dependencies: eos, kernel, physcon, table_utils
 !
  use physcon,          only:pi,gg,solarm,solarr,kb_on_mh
  use table_utils,      only:interpolator,diff

diff --git a/src/setup/setup_dustsettle.f90 b/src/setup/setup_dustsettle.f90
@@ -10,13 +10,27 @@ module setup
 !
 ! :References: Price & Laibe (2015), MNRAS 451, 5332
 !
-! :Owner: Daniel Price
+! :Owner: James Wurster
 !
-! :Runtime parameters: None
+! :Runtime parameters:
+!   - HonR              : *ratio of H/R*
+!   - Rdisc             : *radius at which the calculations will be made [au]*
+!   - Rmax              : *Complete N revolutions at what radius? [au]*
+!   - dust_to_gas_ratio : *dust-to-gas ratio*
+!   - graindenscgs      : *grain density [g/cm^3]*
+!   - grainsizecgs      : *grain size in [cm]*
+!   - ndusttypes        : *number of grain sizes*
+!   - norbit            : *Number of orbits at Rmax*
+!   - npartx            : *requested number of particles in x-direction*
+!   - rhozero           : *midplane density (> 0 for code units; < 0 for cgs)*
+!   - sindex            : *power-law index, e.g. MRN*
+!   - smaxcgs           : *maximum grain size [cm]*
+!   - smincgs           : *minimum grain size [cm]*
+!   - stellar_mass      : *mass of the central star [Msun]*
 !
-! :Dependencies: boundary, dim, domain, dust, externalforces, io, mpiutils,
-!   options, part, physcon, prompting, set_dust, setup_params, table_utils,
-!   timestep, unifdis, units
+! :Dependencies: boundary, dim, domain, dust, externalforces, infile_utils,
+!   io, mpiutils, options, part, physcon, prompting, set_dust,
+!   setup_params, table_utils, timestep, unifdis, units
 !
  use part,           only:ndusttypes,ndustsmall
  use dust,           only:grainsizecgs,graindenscgs

diff --git a/src/setup/setup_gwdisc.f90 b/src/setup/setup_gwdisc.f90
@@ -28,8 +28,8 @@ module setup
 !   - p_indexinput : *surface density profile*
 !   - q_indexinput : *temperature profile*
 !
-! :Dependencies: extern_binary, externalforces, infile_utils, io, options,
-!   physcon, prompting, setdisc, units
+! :Dependencies: externalforces, infile_utils, io, options, physcon,
+!   prompting, setdisc, units
 !
  implicit none
  public :: setpart

diff --git a/src/setup/setup_params.f90 b/src/setup/setup_params.f90
@@ -14,7 +14,7 @@ module setup_params
 !
 ! :Runtime parameters: None
 !
-! :Dependencies: dim
+! :Dependencies: None
 !
  implicit none
  real            :: rmax,rhozero

diff --git a/src/setup/setup_star.f90 b/src/setup/setup_star.f90
@@ -33,7 +33,7 @@ module setup
 !   - ieos               : *1=isothermal,2=adiabatic,10=MESA,12=idealplusrad*
 !   - initialtemp        : *initial temperature of the star*
 !   - isinkcore          : *Add a sink particle stellar core*
-!   - isoftcore          : *Soften the core of an input MESA profile*
+!   - isoftcore          : *0=no core softening, 1=cubic core, 2=constant entropy core*
 !   - isofteningopt      : *1=supply hsoft, 2=supply mcore, 3=supply both*
 !   - mass_unit          : *mass unit (e.g. solarm)*
 !   - mcore              : *Mass of sink particle stellar core*
@@ -48,8 +48,9 @@ module setup
 !
 ! :Dependencies: centreofmass, dim, domain, eos, eos_idealplusrad,
 !   extern_densprofile, externalforces, infile_utils, io, kernel, options,
-!   part, physcon, prompting, relaxstar, rho_profile, setsoftenedcore,
-!   setstellarcore, setup_params, spherical, table_utils, timestep, units
+!   part, physcon, prompting, relaxstar, rho_profile, setfixedentropycore,
+!   setsoftenedcore, setstellarcore, setup_params, spherical, table_utils,
+!   timestep, units
 !
  use io,             only:fatal,error,master
  use part,           only:gravity

diff --git a/src/tests/test_sedov.F90 b/src/tests/test_sedov.F90
@@ -14,10 +14,9 @@ module testsedov
 !
 ! :Runtime parameters: None
 !
-! :Dependencies: boundary, deriv, dim, domain, energies, eos, evolve,
-!   evwrite, io, io_summary, mpiutils, options, part,
-!   physcon, radiation_utils, testutils, timestep, unifdis, units,
-!   viscosity
+! :Dependencies: boundary, checkconserved, deriv, dim, domain, energies,
+!   eos, evolve, evwrite, io, io_summary, mpiutils, options, part, physcon,
+!   radiation_utils, testutils, timestep, unifdis, units, viscosity
 !
  implicit none
 

diff --git a/src/tests/test_step.F90 b/src/tests/test_step.F90
@@ -14,9 +14,9 @@ module teststep
 !
 ! :Runtime parameters: None
 !
-! :Dependencies: boundary, dim, domain, eos, io, mpiutils, options, part,
-!   physcon, step_lf_global, testutils, timestep, timestep_ind, timing,
-!   unifdis, viscosity
+! :Dependencies: boundary, checksetup, deriv, dim, domain, eos, io,
+!   mpiutils, options, part, physcon, step_lf_global, testutils, timestep,
+!   timestep_ind, timing, unifdis, viscosity
 !
  implicit none
  public :: test_step

diff --git a/src/utils/analysis_binarydisc.f90 b/src/utils/analysis_binarydisc.f90
@@ -8,17 +8,6 @@ module analysis
 !
 ! Analysis routine for discs in binary systems by CJN
 !
-! Method:
-! "primary(secondary)" implies tag=1(2) not anything to do with mass or disc hosting etc.
-! Circumprimary   disc: only particles inside the primary   Roche-lobe & bound
-! Circumsecondary disc: only particles inside the secondary Roche-lobe & bound
-! Circumbinary    disc: only particles at R > a (semi-major axis, not separation) & bound
-!
-! Creates: binary.dat      for binary params
-!          circumprimary_*.dat   for circumprimary disc params
-!          circumsecondary_*.dat for circumsecondary disc params
-!          circumbinary_*.dat    for circumbinary disc params
-!
 ! :References: None
 !
 ! :Owner: Daniel Price

diff --git a/src/utils/analysis_mcfost.f90 b/src/utils/analysis_mcfost.f90
@@ -15,8 +15,8 @@ module analysis
 !
 ! :Runtime parameters: None
 !
-! :Dependencies: deriv, dim, eos, growth, io,
-!   mcfost2phantom, omp_lib, options, part, physcon, timestep, units
+! :Dependencies: deriv, dim, energies, eos, growth, io, mcfost2phantom,
+!   omp_lib, options, part, physcon, timestep, units
 !
  use omp_lib
 

diff --git a/src/utils/moddump_binarystar.f90 b/src/utils/moddump_binarystar.f90
@@ -14,9 +14,9 @@ module moddump
 !
 ! :Runtime parameters: None
 !
-! :Dependencies: centreofmass, dim, extern_gwinspiral, externalforces,
-!   io, options, part, physcon, prompting, readwrite_dumps, timestep,
-!   units
+! :Dependencies: centreofmass, dim, energies, extern_gwinspiral,
+!   externalforces, io, options, part, physcon, prompting, readwrite_dumps,
+!   timestep, units
 !
  implicit none
 

diff --git a/src/utils/moddump_removeparticles_radius.f90 b/src/utils/moddump_removeparticles_radius.f90
@@ -10,7 +10,7 @@ module moddump
 !
 ! :References: None
 !
-! :Owner: Daniel Mentiplay
+! :Owner: Arnaud Vericel
 !
 ! :Runtime parameters: None
 !

diff --git a/src/utils/phantom_moddump.f90 b/src/utils/phantom_moddump.f90
@@ -14,7 +14,7 @@ program phantommoddump
 !
 ! :Usage: moddump dumpfilein dumpfileout [time] [outformat]
 !
-! :Dependencies: checksetup, dim, eos, io, memory, moddump,
+! :Dependencies: checkconserved, checksetup, dim, eos, io, memory, moddump,
 !   options, part, prompting, readwrite_dumps, readwrite_infile, setBfield,
 !   setup_params
 !