PhyStar Documentation

PhyStar（星曜）

PhyStar is a numerical package designed to help physical scientists simulate and analyse physical phenomena with a wide range of applications. PhyStar has now supported particle-laden flows in

1. Analytical flow:TGV, Shear flow
2. Homogeneous isotropic turbulence (HIT): Quasi-spectral method
3. Turbulent channel flow (TCF): Quasi-spectral and differential methods
4. ......

Principal: Zhiwen Cui

Organization: Tsinghua University

E-mail: czw17.nosp@m.@tsi.nosp@m.nghua.nosp@m..org.nosp@m..cn

List of the contributors can be found here.

If you have any problem, please contact me (@Cui-ZW) without hesitation or create an issue for a better solution.

Solver List

Solver	Info
SimCartFlow	generate analytical flow in cartesian coordinate, such as TGV, linear shear flow
CartBoxFFT	triply cartesian periodic box calculated by FFT, spectral method, such as HIT, TGV
CartBoxFFD	x-,y- directions are periodic and computed by FFT spectral method, while z- direction is non-periodic and computed by 2nd-order central difference method. For example, channel flow, Couette flow and so on.
CartBoxFDM	the 2nd-order central finite difference method. The possion equation is solved by FFT-base method, and the immersed boundary method is avaliable in this version.
CartPPSol	particle-particle solver in cartesian box. This solver supports massive point-particle and particle-resolved particles with particle-particle interactions, such as collision, cohesion and so on.

---

3rd-party library

• represents that header-only sources have been included in PhyStar
• hdf5
• openblas
• fftw3
• hpp-fcl
• nanoflann*
• tomlplusplus*
• blitz*

THESE LIBRARIES CAN BE INSTALLED AUTOMATICALLY BY Dependencies

Note: Please download fcl from my repo fcl-modify, where some bugs are fixed.

Parallel

• tfft3d: three-dimensional transpose & FFT
• gsmpi: gather & scatter mpi

IO

• FileIO: file io based on HDF5, including fluid and particle
• DictIO: read dictionary configurtion file, written in toml style
• LogIO: print log to file (To do)
• ExceIO: Exception information print (To do)

Math

• blin:blitz+cblas (To do)
• quadpackhpp: header only quadpack code
• Interp:
• ode: (wil be decrapted)
• random: generate random numbers

SmartParticle

Algo

• KNN: kdtree for nearest searching

DMDyn

• Angular
• ContactModel
• DataStruct
• DMClass
• ForceModel
• TwoWayCouple

IBM

• Immersed boundary method
• IBMClass
• IBMIO
• IBMUtils

FDM

• Finite Difference Method
• DiffOp

BlockElm

• Field
• Mesh
• Block

Solver

• DataSpace
• FluidSol
• PPSol(including point-particle and particle-resolved methods)
• ScalarSol (To Do）
• MHD (To Do)

Pre-Post (To Do)

• Init
• Convert

Contributors

Name	Organization	E-mail	Contribution
Cui Zhiwen	2017.9-now Tsinghua University from 2024.10 Hunan University	czw17.nosp@m.@tsi.nosp@m.nghua.nosp@m..org.nosp@m..cn	PI, original version, framework, etc.
Qiu Jingran	2018.9-2023.6 Tsinghua University 2024.1-now Gothenburg University		smart particle, ppsol etc.
Huang Jianda	2022.9-now Tsinghua University		cohesive particle, two-way coupling

---