How to Develop KAPSEL

File List

alloc.cMemory allocation routines
alloc.hMemory allocation routines (header file)
avs_output.cxxOutput routines for field data in AVS/Express format
avs_output.hOutput routines for field data in AVS/Express format (header file)
avs_output_p.cxxOutput routines for particle data in AVS/Express format
avs_output_p.hOutput routines for particle data in AVS/Express format (header file)
f_particle.cxxCompute Hydrodynamic force on particle
f_particle.hCompute Hydrodynamic force on particle (header file)
fft_wrapper.cxxFFT wrapper routines for reciprocal space calculations
fft_wrapper.hFFT wrapper routines for reciprocal space calculations (header file)
fftsg.cOoura's 1D FFT routines
fftsg3d.cOoura's 3D FFT routines
fluct.cxxRoutines to compute random thermal fluctuation forces
fluct.hRoutines to compute random thermal fluctuation forces (header file)
fluid_solver.cxxSolver for Navier-Stokes equations
fluid_solver.hSolver for Navier-Stokes equations (header file)
init_fluid.cxxInitialize fluid velocity fields
init_fluid.hInitialize fluid velocity fields (header file)
init_particle.cxxInitialize particle properties
init_particle.hInitialize particle properties (header file)
input.cxxRead udf input file to start simulation
input.hRead udf input file to start simulation (header file)
interaction.cxxCompute inter-particle interactions
interaction.hCompute inter-particle interactions (header file)
lad3.hBasic Matrix / Vector Euclidean 3D routines (not very optimized)
macro.hGlobal parameters and macro function definitions
make_phi.cxxRoutines to compute smooth profile and grid particle properties
make_phi.hRoutines to compute smooth profile and grid particle properties (header file)
Matrix_Inverse.h
md_force.cxxRoutines to compute MD forces on particles
md_force.hRoutines to compute MD forces on particles (header file)
mt19937ar.cRandon number generator - You get what you deserve if you modify this file !
operate_electrolyte.cxxRoutines to compute the charge distributions and forces
operate_electrolyte.hRoutines to compute the charge distributions and forces (header file)
operate_omega.cxxHigh-level routines to handle basic operations on velocity field
operate_omega.hHigh-level routines to handle basic operations on velocity field (header file)
operate_surface.cxxRoutines to control the slip velocity at particle fluid boundaries
operate_surface.hRoutines to control the slip velocity at particle fluid boundaries (header file)
parameter_define.hDefine global system parameters for FFT routines
particle_solver.cxxSolver routines for particle position and velocity
particle_solver.hSolver routines for particle position and velocity (header file)
profile.cxxSmooth particle profile routines
profile.hSmooth particle profile routines (header file)
quaternion.hImplements simple quaternion algebra
resume.cxxRoutines to read/write restart file
resume.hRoutines to read/write restart file (header file)
rigid.h
rigid_body.cxxAuxiliary routines to solve equations of motion for rigid bodies
rigid_body.hAuxiliary routines to solve equations of motion for rigid bodies (header file)
solute_rhs.cxxRoutines to compute the terms appearing in the right hand side of the solute advection diffusion equation
solute_rhs.hRoutines to compute the terms appearing in the right hand side of the solute advection diffusion equation (header file)
sp_3d_ns.cxxMain program file
sp_3d_ns.hMain program file (header)
variable.hDefines the global structs (CTime, Particle, Index_range)
Tools/udf2xyz.cxx
Tools/helixudf_generator/A tool to generate initial configuration of helicesfor "input.udf"

DOXYGEN

  • Useful documentations (generated by Doxygen) are provided within the package. One can find and browse the following files.
Doxygen/html/index.htmlTo be updated
Doxygen/html/pages.htmlTo be updated
Doxygen/html/annotated.htmlDetailed explanations of the data structures
Doxygen/html/files.htmlDetailed explanations of the all source codes including the dependencies of the functions


doxygen_files.jpg

GIT

  • Bug fixes and new implementations between major updates are provided through Github. You may make a local clone of the newest KAPSEL package by
 > git clone git@github.com:kapsel-dns/kapsel.git my_local_kapsel
git.jpg

Contact