Skip to content

Support output psidm derived fields in hdf5 #494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vivi235711 wants to merge 4 commits into
base: main
Choose a base branch
from
+465 −9
Open

Support output psidm derived fields in hdf5 #494

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ae5832b
Feat: Output ELBDM derived fields to HDF5
vivi235711 Nov 13, 2025
c86082d
[Workflow] Update all parameters wiki page
vivi235711 Nov 13, 2025
5f6fd59
Output ELBDM derived fields to part
vivi235711 Nov 27, 2025
e425f18
Merge branch 'output_psidm_field' of github.com:vivi235711/gamer into…
vivi235711 Nov 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/wiki/Runtime-Parameters-related/Runtime-Parameters:-All.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,9 @@ For variables with `Default/Min/Max` labeled as `Depend`, click the parameter na
| [[ OPT__OUTPUT_CS \| Runtime-Parameters:-Outputs#OPT__OUTPUT_CS ]] | 0 | None | None | output sound speed [0] ##HYDRO ONLY## |
| [[ OPT__OUTPUT_DIVMAG \| Runtime-Parameters:-Outputs#OPT__OUTPUT_DIVMAG ]] | 0 | None | None | output |divergence(B)*dh/|B|| [0] ##MHD ONLY## |
| [[ OPT__OUTPUT_DIVVEL \| Runtime-Parameters:-Outputs#OPT__OUTPUT_DIVVEL ]] | 0 | None | None | output divergence(velocity) [0] ##HYDRO ONLY## |
| OPT__OUTPUT_ELBDM_Q_POT | 0 | None | None | output ELBDM quantum potential potential [0] ##ELBDM ONLY## |
| OPT__OUTPUT_ELBDM_Q_STRESS | 0 | None | None | output ELBDM quantum stress tensor [0] ##ELBDM ONLY## |
| OPT__OUTPUT_ELBDM_VEL | 0 | None | None | output ELBDM velocity [0] ##ELBDM ONLY## |
| [[ OPT__OUTPUT_ENTHALPY \| Runtime-Parameters:-Outputs#OPT__OUTPUT_ENTHALPY ]] | 1 | None | None | output reduced enthalpy [1] ##SRHD ONLY## |
| [[ OPT__OUTPUT_ENTR \| Runtime-Parameters:-Outputs#OPT__OUTPUT_ENTR ]] | 0 | None | None | output gas entropy [0] ##HYDRO ONLY## |
| [[ OPT__OUTPUT_LORENTZ \| Runtime-Parameters:-Outputs#OPT__OUTPUT_LORENTZ ]] | 0 | None | None | output Lorentz factor [0] ##SRHD ONLY## |
Expand Down
3 changes: 3 additions & 0 deletions example/test_problem/Template/Input__Parameter
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,9 @@ OPT__OUTPUT_DIVMAG 0 # output |divergence(B)*dh/|B|| [0] ##
OPT__OUTPUT_LORENTZ 0 # output Lorentz factor [0] ##SRHD ONLY##
OPT__OUTPUT_3VELOCITY 0 # output 3-velocities [0] ##SRHD ONLY##
OPT__OUTPUT_ENTHALPY 1 # output reduced enthalpy [1] ##SRHD ONLY##
OPT__OUTPUT_ELBDM_VEL 0 # output ELBDM velocity [0] ##ELBDM ONLY##
OPT__OUTPUT_ELBDM_Q_POT 0 # output ELBDM quantum potential potential [0] ##ELBDM ONLY##
OPT__OUTPUT_ELBDM_Q_STRESS 0 # output ELBDM quantum stress tensor [0] ##ELBDM ONLY##
OPT__OUTPUT_USER_FIELD 0 # output user-defined derived fields [0] -> edit "Flu_DerivedField_User.cpp"
OPT__OUTPUT_MODE 1 # (1=const step, 2=const dt, 3=dump table) -> edit "Input__DumpTable" for 3
OPT__OUTPUT_RESTART 0 # output data immediately after restart [0]
Expand Down
1 change: 1 addition & 0 deletions include/Global.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ extern bool OPT__OUTPUT_ENTHALPY;
#elif ( MODEL == ELBDM )
extern double DT__PHASE, FlagTable_EngyDensity[NLEVEL-1][2];
extern bool OPT__FLAG_ENGY_DENSITY, OPT__INT_PHASE, OPT__RES_PHASE, ELBDM_TAYLOR3_AUTO;
extern bool OPT__OUTPUT_ELBDM_VEL, OPT__OUTPUT_ELBDM_Q_POT, OPT__OUTPUT_ELBDM_Q_STRESS;
extern double ELBDM_TAYLOR3_COEFF, ELBDM_MASS, ELBDM_PLANCK_CONST, ELBDM_ETA, MIN_DENS;
#ifdef QUARTIC_SELF_INTERACTION
extern double ELBDM_LAMBDA;
Expand Down
5 changes: 5 additions & 0 deletions include/HDF5_Typedef.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -823,6 +823,11 @@ struct InputPara_t
int Opt__Output_Cs;
int Opt__Output_DivVel;
int Opt__Output_Mach;
# if ( MODEL == ELBDM )
int Opt__Output_ELBDM_Vel;
int Opt__Output_ELBDM_Q_Pot;
int Opt__Output_ELBDM_Q_Stress;
# endif
# ifdef MHD
int Opt__Output_DivMag;
# endif
Expand Down
7 changes: 5 additions & 2 deletions include/Macro.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@


// maximum number of output derived fields
# define DER_NOUT_MAX 10
# define DER_NOUT_MAX 30


// maximum number of fields to be stored in HDF5 snapshots
Expand Down Expand Up @@ -831,7 +831,7 @@

// number of ghost zones for computing derived fields
# define DER_GHOST_SIZE 1

# define ELBDM_DER_GHOST_SIZE 2

// number of ghost zones for feedback
// --> can be changed manually
Expand Down Expand Up @@ -875,6 +875,9 @@
# define SRC_NXT ( PS1 + 2*SRC_GHOST_SIZE ) // use patch as the unit
# define SRC_NXT_P1 ( SRC_NXT + 1 )
# define DER_NXT ( PS1 + 2*DER_GHOST_SIZE ) // use patch as the unit
#if ( MODEL == ELBDM )
# define ELBDM_DER_NXT ( PS1 + 2*ELBDM_DER_GHOST_SIZE ) // use patch as the unit
#endif
#ifdef FEEDBACK
# define FB_NXT ( PS2 + 2*FB_GHOST_SIZE ) // use patch group as the unit
#endif
Expand Down
2 changes: 2 additions & 0 deletions include/Prototype.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -608,6 +608,8 @@ bool ELBDM_Flag_Interference( const int i, const int j, const int k, const rea
real ELBDM_UnwrapPhase( const real Phase_Ref, const real Phase_Wrapped );
real ELBDM_SetTaylor3Coeff( const real dt, const real dh, const real Eta );
void ELBDM_RemoveMotionCM();
void ELBDM_DerivedField( real ELBDMOut[], const real ELBDMIn[], int FieldID,
int direction, const int NGhost, const real dh );
#ifdef SUPPORT_FFTW
void CPU_ELBDMSolver_FFT( const real dt, const double PrepTime, const int SaveSg );
#endif
Expand Down
5 changes: 5 additions & 0 deletions src/Auxiliary/Aux_TakeNote.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1622,6 +1622,11 @@ void Aux_TakeNote()
# endif
# ifdef MHD
fprintf( Note, "OPT__OUTPUT_DIVMAG % d\n", OPT__OUTPUT_DIVMAG );
# endif
# if ( MODEL == ELBDM )
fprintf( Note, "OPT__OUTPUT_ELBDM_VEL % d\n", OPT__OUTPUT_ELBDM_VEL );
fprintf( Note, "OPT__OUTPUT_ELBDM_Q_POT % d\n", OPT__OUTPUT_ELBDM_Q_POT );
fprintf( Note, "OPT__OUTPUT_ELBDM_Q_STRESS % d\n", OPT__OUTPUT_ELBDM_Q_STRESS );
# endif
fprintf( Note, "OPT__OUTPUT_USER_FIELD % d\n", OPT__OUTPUT_USER_FIELD );
# ifdef SRHD
Expand Down
5 changes: 5 additions & 0 deletions src/Init/Init_Load_Parameter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,6 +540,11 @@ void Init_Load_Parameter()
ReadPara->Add( "OPT__OUTPUT_LORENTZ", &OPT__OUTPUT_LORENTZ, false, Useless_bool, Useless_bool );
ReadPara->Add( "OPT__OUTPUT_3VELOCITY", &OPT__OUTPUT_3VELOCITY, false, Useless_bool, Useless_bool );
ReadPara->Add( "OPT__OUTPUT_ENTHALPY", &OPT__OUTPUT_ENTHALPY, true, Useless_bool, Useless_bool );
# endif
# if ( MODEL == ELBDM )
ReadPara->Add( "OPT__OUTPUT_ELBDM_VEL", &OPT__OUTPUT_ELBDM_VEL, false, Useless_bool, Useless_bool );
ReadPara->Add( "OPT__OUTPUT_ELBDM_Q_POT", &OPT__OUTPUT_ELBDM_Q_POT, false, Useless_bool, Useless_bool );
ReadPara->Add( "OPT__OUTPUT_ELBDM_Q_STRESS", &OPT__OUTPUT_ELBDM_Q_STRESS, false, Useless_bool, Useless_bool );
# endif
ReadPara->Add( "OPT__OUTPUT_USER_FIELD", &OPT__OUTPUT_USER_FIELD, false, Useless_bool, Useless_bool );
ReadPara->Add( "OPT__OUTPUT_MODE", &OPT__OUTPUT_MODE, -1, 1, 3 );
Expand Down
1 change: 1 addition & 0 deletions src/Main/Main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ bool OPT__OUTPUT_ENTHALPY;
#elif ( MODEL == ELBDM )
double DT__PHASE, FlagTable_EngyDensity[NLEVEL-1][2];
bool OPT__FLAG_ENGY_DENSITY, OPT__INT_PHASE, OPT__RES_PHASE;
bool OPT__OUTPUT_ELBDM_VEL, OPT__OUTPUT_ELBDM_Q_POT, OPT__OUTPUT_ELBDM_Q_STRESS;
bool ELBDM_TAYLOR3_AUTO;
double ELBDM_TAYLOR3_COEFF;
double ELBDM_MASS, ELBDM_PLANCK_CONST, ELBDM_ETA, MIN_DENS;
Expand Down
2 changes: 1 addition & 1 deletion src/Makefile_base
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ CPU_FILE += CPU_ELBDMSolver_FD.cpp CPU_ELBDMSolver_FFT.cpp CPU_ELBDMSolver_
CPU_ELBDMSolver_HJ.cpp ELBDM_Init_ByFunction_AssignData.cpp ELBDM_GetTimeStep_Fluid.cpp ELBDM_GetTimeStep_Hybrid_CFL.cpp \
ELBDM_Flag_EngyDensity.cpp ELBDM_Flag_Interference.cpp ELBDM_Flag_Spectral.cpp ELBDM_UnwrapPhase.cpp \
ELBDM_GetTimeStep_Phase.cpp ELBDM_GetTimeStep_Hybrid_Velocity.cpp ELBDM_HasWaveCounterpart.cpp ELBDM_SetTaylor3Coeff.cpp \
ELBDM_GramFE_EvolutionMatrix.cpp ELBDM_RemoveMotionCM.cpp ELBDM_Aux_Record_Hybrid.cpp
ELBDM_GramFE_EvolutionMatrix.cpp ELBDM_RemoveMotionCM.cpp ELBDM_Aux_Record_Hybrid.cpp ELBDM_DerivedField.cpp

vpath %.cu Model_ELBDM/GPU_ELBDM
vpath %.cpp Model_ELBDM/CPU_ELBDM Model_ELBDM
Expand Down
Loading