Update definition of m_flow in the docs, including the sign for the outlet and inlet. (f74c6e36) · Commits · AGS_public / geoloop

docs/manual/simulation_configuration.md

+49 −49

Original line number	Diff line number	Diff line
		@@ -102,7 +102,7 @@ For an example of a simple deterministic model simulation, see the example of a
		The main input JSON file includes the following parameters:

		\| Parameter \| Description \| Unit \| Type \| Remark \|
		\|----------------------\|------------------------------------------------------------------------\|---------\|----------------\|------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
		\|----------------------\|------------------------------------------------------------------------\|---------\|----------------\|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
		\| base_dir \| Path to output folder \| — \| string \| Creates folder if it does not exist \|
		\| type \| Type of BHE design \| — \| string \| Options: UTUBE or COAXIAL for `model_type` ANALYTICAL and PYG and PYGFIELD; UTUBE for `model_type` FINVOL \|
		\| H \| Borehole length \| m \| scalar \| — \|
		@@ -122,7 +122,7 @@ The main input JSON file includes the following parameters:
		\| epsilon \| Pipe surface roughness \| m \| scalar \| — \|
		\| fluid_str \| Type of fluid mixed with water \| — \| string \| Must be supported by `pygfunction` media module \|
		\| fluid_percent \| Fluid percentage \| % \| scalar \| — \|
		\| m_flow \| Flow rate per pipe \| kg/s \| scalar \| The total flow into the system is the sum of the flow rates for the nr. of inlet pipes. Used if `dploopcrit` and `flow_data` are not defined \|
		\| m_flow \| Total flow rate \| kg/s \| scalar \| The total flow into the system is is equally divided between the sets of inlet and outlet pipes, with a negative value for the outlet flow. Used if `dploopcrit` and `flow_data` are not defined. \|
		\| litho_k_param \| Path to lithology module configuration file \| — \| string \| Optional \|
		\| Tg \| (Sub)surface temperature \| °C \| scalar or list \| Represents surface temperature if scalar \|
		\| Tgrad \| Subsurface temperature gradient \| °C/100m \| scalar \| Used only if `Tg` is scalar \|
		@@ -282,7 +282,7 @@ samples.
		\| T_fo \| Outlet temperature \| C \| time \| \|
		\| Tg \| (Sub)surface temperature \| C \| time or time; zseg \| \|
		\| dploop \| Pumping pressure \| bar \| time \| \|
		\| flowrate \| Flowrate \| kg/s \| time \| The flow rate in each pipe \|
		\| flowrate \| Flowrate \| kg/s \| time \| Total flow rate \|
		\| hours \| Simulation timesteps \| hours \| time \| \|
		\| k_g \| Grout thermal conductivity \| W/mK \| time or time; zseg \| \|
		\| k_s \| Subsurface thermal conductivity \| W/mK \| time or time; zseg \| \|

Original line number	Diff line number	Diff line
		@@ -102,7 +102,7 @@ For an example of a simple deterministic model simulation, see the example of a
		The main input JSON file includes the following parameters:

		\| Parameter \| Description \| Unit \| Type \| Remark \|
		\|----------------------\|------------------------------------------------------------------------\|---------\|----------------\|------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
		\|----------------------\|------------------------------------------------------------------------\|---------\|----------------\|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
		\| base_dir \| Path to output folder \| — \| string \| Creates folder if it does not exist \|
		\| type \| Type of BHE design \| — \| string \| Options: UTUBE or COAXIAL for `model_type` ANALYTICAL and PYG and PYGFIELD; UTUBE for `model_type` FINVOL \|
		\| H \| Borehole length \| m \| scalar \| — \|
		@@ -122,7 +122,7 @@ The main input JSON file includes the following parameters:
		\| epsilon \| Pipe surface roughness \| m \| scalar \| — \|
		\| fluid_str \| Type of fluid mixed with water \| — \| string \| Must be supported by `pygfunction` media module \|
		\| fluid_percent \| Fluid percentage \| % \| scalar \| — \|
		\| m_flow \| Flow rate per pipe \| kg/s \| scalar \| The total flow into the system is the sum of the flow rates for the nr. of inlet pipes. Used if `dploopcrit` and `flow_data` are not defined \|
		\| m_flow \| Total flow rate \| kg/s \| scalar \| The total flow into the system is is equally divided between the sets of inlet and outlet pipes, with a negative value for the outlet flow. Used if `dploopcrit` and `flow_data` are not defined. \|
		\| litho_k_param \| Path to lithology module configuration file \| — \| string \| Optional \|
		\| Tg \| (Sub)surface temperature \| °C \| scalar or list \| Represents surface temperature if scalar \|
		\| Tgrad \| Subsurface temperature gradient \| °C/100m \| scalar \| Used only if `Tg` is scalar \|
		@@ -282,7 +282,7 @@ samples.
		\| T_fo \| Outlet temperature \| C \| time \| \|
		\| Tg \| (Sub)surface temperature \| C \| time or time; zseg \| \|
		\| dploop \| Pumping pressure \| bar \| time \| \|
		\| flowrate \| Flowrate \| kg/s \| time \| The flow rate in each pipe \|
		\| flowrate \| Flowrate \| kg/s \| time \| Total flow rate \|
		\| hours \| Simulation timesteps \| hours \| time \| \|
		\| k_g \| Grout thermal conductivity \| W/mK \| time or time; zseg \| \|
		\| k_s \| Subsurface thermal conductivity \| W/mK \| time or time; zseg \| \|