Compilation preprocessor settings - Revision history

Guillaume at 13:04, 24 April 2012

2012-04-24T13:04:26Z

2012-04-24T11:56:48Z

2012-04-10T11:33:22Z

2012-04-10T11:10:56Z

2012-04-10T11:08:30Z

2012-04-10T10:37:24Z

2012-04-10T10:30:54Z

2012-04-10T10:08:16Z

2012-04-10T10:01:56Z

2012-04-10T09:59:28Z

← Older revision		Revision as of 13:04, 24 April 2012
Line 66:		Line 66:

	'''_GUI_''' includes GUI code		'''_GUI_''' includes GUI code
		+
		+	== Google maps compatible output ==
		+	''Scope: MohidBase2, MohidWater''
		+
		+	'''_GOOGLEMAPS''' Generates google compatible mapping coordinates

	==Errors that may arise from incorrect preprocessor variables definition==		==Errors that may arise from incorrect preprocessor variables definition==

← Older revision		Revision as of 11:56, 24 April 2012
Line 21:		Line 21:

	'''_USE_NIX''' Uses linux filesystem commands.		'''_USE_NIX''' Uses linux filesystem commands.
		+
		+	== Library Options ==
		+	As the pre-built Netcdf library for windows x64 with the fortran binding is a rare bird to find, sometimes one may have to exclude the regions of code containing access to netcdf files.
		+
		+	''Scope: MohidBase1, MohidBase2, ConvertToHdf5''
		+
		+	'''_NO_NETCDF''' Excludes regions of code that access netcdf files. To use when a pre-built netcdf library is unavailable.

	== Performance options ==		== Performance options ==

← Older revision		Revision as of 11:33, 10 April 2012
Line 2:		Line 2:

	The advanced MOHID user should be aware of the optional preprocessor settings as the released executables don't contain all the possibilities available and this obliges one to compile its own version of the MOHID executable under certain circumstances.		The advanced MOHID user should be aware of the optional preprocessor settings as the released executables don't contain all the possibilities available and this obliges one to compile its own version of the MOHID executable under certain circumstances.
		+
		+	[[image:VStudio-Ifort-PreprocessorDefinitions-HowTo.PNG]]

	== Exclude modules ==		== Exclude modules ==

@@ Line 47: / Line 47: @@
 ==Stack Management ==
-Stack memory is limited to 1GB in all recent Windows versions (either 32 or 64 bits). Thus, it happens quite frequently that simulations that include the Waterquality or Life modules use stack extensively. One way to deal with Stack limitations is by defining ''Stack Reserve'' in the linker options. However, when ''Stack Reserve'' fails, then removing some features of the software can help reduce the stack consumption. In particular, this option, when enabled, removes the calculation of the Minimum and Maximum attributes in the results in the HDF5 files.
+Stack memory is limited to 1GB in all recent Windows versions (either 32 or 64 bits). Thus, it happens quite frequently that simulations that include the Waterquality or Life modules use stack extensively. One way to deal with [[Stack_overflow|Stack limitations]] is by defining ''Stack Reserve'' in the linker options. However, when ''Stack Reserve'' fails, then removing some features of the software can help reduce the stack consumption. In particular, this option, when enabled, removes the calculation of the Minimum and Maximum attributes in the results in the HDF5 files.
   ''Scope: MohidBase1 (ModuleHDF5)''

← Older revision		Revision as of 11:08, 10 April 2012
Line 45:		Line 45:

	'''_INCREASE_MAXINSTANCES''' sets maximum number of object instances to 2000 (default is 500)		'''_INCREASE_MAXINSTANCES''' sets maximum number of object instances to 2000 (default is 500)
		+
		+	==Stack Management ==
		+	Stack memory is limited to 1GB in all recent Windows versions (either 32 or 64 bits). Thus, it happens quite frequently that simulations that include the Waterquality or Life modules use stack extensively. One way to deal with Stack limitations is by defining ''Stack Reserve'' in the linker options. However, when ''Stack Reserve'' fails, then removing some features of the software can help reduce the stack consumption. In particular, this option, when enabled, removes the calculation of the Minimum and Maximum attributes in the results in the HDF5 files.
		+
		+	''Scope: MohidBase1 (ModuleHDF5)''
		+
		+	'''_STACK_LIMITS_''' disables the calculation of the Minimum and Maximum attributes in the results in the HDF5 files.

	== Graphical options ==		== Graphical options ==

@@ Line 38: / Line 38: @@
   '''_EXTRA_SHORT_LINE_LENGTH'''  sets line_length = 32
-== Miscelaneous options ==
+== Instances Management ==
   ''Scope: MohidBase1 (ModuleGlobalData, ModuleHdf5)''

@@ Line 5: / Line 5: @@
 == Exclude modules ==
 Some modules can be completely excluded from compilation. If your simulations do not use these modules you can use this pre-processor keywords.
   '''_LAGRANGIAN_'''	   excludes Modules Lagrangian + Jet + Oil
@@ Line 28: / Line 30: @@
 Default line_length of input/output ascii files such as TimeSeries is 256, however this can be a problem if the time series contains many many columns with many many properties and exceeds the 256 characters limit. Conveniently, this can be changed by defining the following preprocessor options
-  ''Scope: ModuleGlobalData''
+  ''Scope: MohidBase1 (ModuleGlobalData)''
   '''_SHORT_LINE_LENGTH'''        sets line_length = 64
@@ Line 37: / Line 39: @@
 == Miscelaneous options ==
   '''_GUI_'''              includes GUI code

@@ Line 10: / Line 10: @@
   '''_WAVES_'''	           excludes Module Waves
   '''_SEDIMENT_'''	   excludes Modules SedimentProperties + Consolidation
 == Performance options ==
 Use this option if you want to nest several domains
   '''_USE_MPI'''           includes MPI code

@@ Line 1: / Line 1: @@
-During compilation of the MOHID source code, at preprocessing time, depending on the definition and values of preprocessor variables, different regions of the code will be compiled.
+During compilation of the MOHID source code, at preprocessing time, depending on the definition and values of preprocessor variables, different regions of the code will be compiled. Each preprocessor variable has a scope within the code where it is used. The scope of a preprocessor variable definition can be a single module or it can be the whole solution or only one project of the solution (such as Base1 or Base2).
-The advanced MOHID user should be aware of the optional preprocessor settings as the released executables don't contain all the possibilities available and this obliges one to compile its own version of the MOHID executable.
+The advanced MOHID user should be aware of the optional preprocessor settings as the released executables don't contain all the possibilities available and this obliges one to compile its own version of the MOHID executable under certain circumstances.
 == Exclude modules ==