Inheritance diagram for define_problem.DefineProblem:

Collaboration diagram for define_problem.DefineProblem:

Public Member Functions
def	__init__ (self, work_dir, pluto_dir, auto_update)

def	ChkCompatiblity (self)

def	GenerateOptionsList (self)

def	AfterFlagLists (self)

def	ReadOrBrowse

def	ProcessHDModule (self)

def	ProcessRHDModule (self)

def	ProcessMHDModule (self)

def	ProcessRMHDModule (self)

def	ProcessUserDefPara (self)

def	ProcessUserDefConst (self)

def	NonUserFriendlyConst (self)

def	AppendAdditionalFiles (self)

def	AppendPlutoPathAndFlags (self)

def	UpdatePlutoIni (self)

def	WriteDefFileList (self)

def	__init__ (self, work_dir, pluto_dir, auto_update)

def	GenerateOptionsList (self)

def	AfterFlagLists (self)

def	ReadOrBrowse

def	ProcessHDModule (self)

def	ProcessRHDModule (self)

def	ProcessMHDModule (self)

def	ProcessRMHDModule (self)

def	ProcessKROMEModule (self)

def	ProcessUserDefPara (self)

def	ProcessUserDefConst (self)

def	NonUserFriendlyConst (self)

def	AppendAdditionalFiles (self)

def	AppendPlutoPathAndFlags (self)

def	UpdatePlutoIni (self)

def	WriteKromeOpts (self)

def	WriteDefFileList (self)

Static Public Attributes
tuple	pf = pfIO.PlutoFiles(self.work_dir+'/definitions.h')

list	tmplist1 = tmplist1+['CHAR_LIMITING', 'LIMITER']

list	tmplist2 = tmplist2+['NO', 'DEFAULT']

list	divb_mode = self.mod_default[self.mod_entries.index('DIVB_CONTROL')]

tuple	longword = max(len(w) for w in tmplist1)

tuple	cmset = set(['CHARACTERISTIC_TRACING', 'HANCOCK'])

Detailed Description

Definition at line 6 of file define_problem.py.

Constructor & Destructor Documentation

def define_problem.DefineProblem.__init__	(	self,
		work_dir,
		pluto_dir,
		auto_update
	)

Defines the problem for the PLUTO code.

This class essentially creates the definitions.h file
based on the inputs given by the user from the PlutoSetup menu.
In case the header file is already present, this class will
read those default values to re-create the file.

**Inputs**:
  1. work_dir = Path to PLUTO code working directory
  2. pluto_dir = Path to PLUTO source directory
  3. auto-update = Boolean that indicates auto-update of definitions.h file.

**Output**:
  It generates a definitions.h file.

Definition at line 7 of file define_problem.py.

     def __init__(self, work_dir, pluto_dir, auto_update):
         """Defines the problem for the PLUTO code.
 
         This class essentially creates the definitions.h file
         based on the inputs given by the user from the PlutoSetup menu.
         In case the header file is already present, this class will
         read those default values to re-create the file.
 
         **Inputs**:
           1. work_dir = Path to PLUTO code working directory
           2. pluto_dir = Path to PLUTO source directory
           3. auto-update = Boolean that indicates auto-update of definitions.h file.
 
         **Output**:
           It generates a definitions.h file.
 
         """
         #Some class attributes that will be used in various class methods.
         self.work_dir = work_dir
         self.pluto_dir = pluto_dir
         self.auto_update = auto_update
         self.def_fname = self.work_dir + '/definitions.h'
         self.additional_files = []
         self.header_files = []
         self.additional_flags = []
         self.pluto_path = []
         self.def_file_list = []
 
         self.ChkCompatiblity() #To Replace Old Keywords with New Ones
 
         # defining the PLUTO entries and its default values in lists.  
         self.entries = ['PHYSICS', 'DIMENSIONS', 'COMPONENTS', 'GEOMETRY',
                         'BODY_FORCE', 'COOLING', 'RECONSTRUCTION', 'TIME_STEPPING',
                         'DIMENSIONAL_SPLITTING', 'NTRACER', 'USER_DEF_PARAMETERS']
         self.default = ['HD', '1', '1', 'CARTESIAN','NO',
                         'NO','LINEAR','RK2',
                         'NO', '0', '0']
 
         # Creating a dictionary of flags that are invoked by giving arguments.
         flag_keys = ['WITH-CHOMBO', 'FULL', 'WITH-FD', 'WITH-SB', 'WITH-FARGO']
         #self.flag_dict = {key: False for key in flag_keys} DOESNT WORK WITH PYTHON 2.6

Here is the caller graph for this function:

def define_problem.DefineProblem.__init__	(	self,
		work_dir,
		pluto_dir,
		auto_update
	)

Defines the problem for the PLUTO code.

This class essentially creates the definitions.h file
based on the inputs given by the user from the PlutoSetup menu.
In case the header file is already present, this class will
read those default values to re-create the file.

**Inputs**:
  1. work_dir = Path to PLUTO code working directory
  2. pluto_dir = Path to PLUTO source directory
  3. auto-update = Boolean that indicates auto-update of definitions.h file.

**Output**:
  It generates a definitions.h file.

Definition at line 7 of file define_problem.without_userdef_constants.py.

     def __init__(self, work_dir, pluto_dir, auto_update):
         """Defines the problem for the PLUTO code.
 
         This class essentially creates the definitions.h file
         based on the inputs given by the user from the PlutoSetup menu.
         In case the header file is already present, this class will
         read those default values to re-create the file.
 
         **Inputs**:
           1. work_dir = Path to PLUTO code working directory
           2. pluto_dir = Path to PLUTO source directory
           3. auto-update = Boolean that indicates auto-update of definitions.h file.
 
         **Output**:
           It generates a definitions.h file.
 
         """
         #Some class attributes that will be used in various class methods.
         self.work_dir = work_dir
         self.pluto_dir = pluto_dir
         self.krome_dir = pluto_dir + 'Lib/krome/'
         self.auto_update = auto_update
         self.def_fname = self.work_dir + '/definitions.h'
         self.additional_files = []
         self.header_files = []
         self.additional_flags = []
         self.pluto_path = []
         self.def_file_list = []
 
         # defining the PLUTO entries and its default values in lists.  
         self.entries = ['PHYSICS', 'DIMENSIONS', 'COMPONENTS', 'GEOMETRY',
                         'BODY_FORCE', 'COOLING', 'INTERPOLATION', 'TIME_STEPPING',
                         'DIMENSIONAL_SPLITTING', 'NTRACER', 'USER_DEF_PARAMETERS'
                         ]
         self.default = ['HD', '1', '1', 'CARTESIAN','NO',
                         'NO','LINEAR','RK2',
                         'YES', '0', '0',
                         ]
 
         # Creating a dictionary of flags that are invoked by giving arguments.
         flag_keys = ['WITH-CHOMBO', 'FULL', 'WITH-FD', 'WITH-SB', 'WITH-FARGO']
         #self.flag_dict = {key: False for key in flag_keys} DOESNT WORK WITH PYTHON 2.6

Here is the call graph for this function:

Member Function Documentation

def define_problem.DefineProblem.AfterFlagLists ( self )

Modify options and default list based on command-line flags.

This method is called after generation of default option list.
It modifies the members of the options list and if required
also the default list based on the conditions required by
the flags set using system arguments.

Definition at line 142 of file define_problem.without_userdef_constants.py.

     def AfterFlagLists(self):
         """Modify options and default list based on command-line flags.
 
         This method is called after generation of default option list.
         It modifies the members of the options list and if required
         also the default list based on the conditions required by
         the flags set using system arguments.
         """
         if self.flag_dict['FULL']:
              self.options[self.entries.index('INTERPOLATION')] = ['FLAT','LINEAR','LimO3', 'WENO3','PARABOLIC', 'MP5']
         
         if self.flag_dict['WITH-CHOMBO']:
             self.options[self.entries.index('GEOMETRY')] = ['CARTESIAN','CYLINDRICAL','POLAR','SPHERICAL']
             self.options[self.entries.index('INTERPOLATION')] = ['FLAT','LINEAR','WENO3','PARABOLIC']
             self.options[self.entries.index('TIME_STEPPING')] = ['EULER','HANCOCK','CHARACTERISTIC_TRACING','RK2']
             self.default[self.entries.index('TIME_STEPPING')] = 'HANCOCK'
             self.options[self.entries.index('DIMENSIONAL_SPLITTING')] = ['NO']
             self.default[self.entries.index('DIMENSIONAL_SPLITTING')] = 'NO'
         
         if self.flag_dict['WITH-FARGO']:
             self.options[self.entries.index('PHYSICS')] = ['HD', 'MHD']
             self.options[self.entries.index('DIMENSIONS')] = ['2','3']
             self.default[self.entries.index('DIMENSIONS')] = '2'
             self.options[self.entries.index('DIMENSIONAL_SPLITTING')] = ['NO']
             self.default[self.entries.index('DIMENSIONAL_SPLITTING')] = 'NO'
             
 
         if self.flag_dict['WITH-FD']:
             self.options[self.entries.index('PHYSICS')] = ['HD', 'MHD']
             self.options[self.entries.index('GEOMETRY')] = ['CARTESIAN']
             self.options[self.entries.index('INTERPOLATION')] = ['WENO3_FD', 'WENOZ_FD', 'MP5_FD','LIMO3_FD']
             self.default[self.entries.index('INTERPOLATION')] = 'WENOZ_FD'
             self.options[self.entries.index('TIME_STEPPING')] = ['RK3']
             self.default[self.entries.index('TIME_STEPPING')] = 'RK3'
             
 
         if self.flag_dict['WITH-SB']:
             self.options[self.entries.index('PHYSICS')] = ['HD', 'MHD']
             self.default[self.entries.index('PHYSICS')] = 'MHD'
             self.options[self.entries.index('DIMENSIONS')] = ['2', '3']
             self.default[self.entries.index('DIMENSIONS')] = '2'
             self.options[self.entries.index('COMPONENTS')] = ['2', '3']
             self.default[self.entries.index('COMPONENTS')] = '2'
             self.options[self.entries.index('BODY_FORCE')] = ['VECTOR', 'POTENTIAL', '(VECTOR+POTENTIAL)']
             self.default[self.entries.index('BODY_FORCE')] = 'VECTOR'
 
 

Here is the call graph for this function:

def define_problem.DefineProblem.AfterFlagLists ( self )

Modify options and default list based on command-line flags.

This method is called after generation of default option list.
It modifies the members of the options list and if required
also the default list based on the conditions required by
the flags set using system arguments.

Definition at line 143 of file define_problem.py.

     def AfterFlagLists(self):
         """Modify options and default list based on command-line flags.
 
         This method is called after generation of default option list.
         It modifies the members of the options list and if required
         also the default list based on the conditions required by
         the flags set using system arguments.
         """
         if self.flag_dict['FULL']:
              self.options[self.entries.index('RECONSTRUCTION')] = ['FLAT','LINEAR','LimO3', 'WENO3','PARABOLIC', 'MP5']
         
         if self.flag_dict['WITH-CHOMBO']:
             self.options[self.entries.index('GEOMETRY')] = ['CARTESIAN','CYLINDRICAL','POLAR','SPHERICAL']
             self.options[self.entries.index('RECONSTRUCTION')] = ['FLAT','LINEAR','WENO3','PARABOLIC']
             self.options[self.entries.index('TIME_STEPPING')] = ['EULER','HANCOCK','CHARACTERISTIC_TRACING','RK2']
             self.default[self.entries.index('TIME_STEPPING')] = 'HANCOCK'
             self.options[self.entries.index('DIMENSIONAL_SPLITTING')] = ['NO']
             self.default[self.entries.index('DIMENSIONAL_SPLITTING')] = 'NO'
         
         if self.flag_dict['WITH-FARGO']:
             self.options[self.entries.index('PHYSICS')] = ['HD', 'MHD']
             self.options[self.entries.index('DIMENSIONS')] = ['2','3']
             self.default[self.entries.index('DIMENSIONS')] = '2'
             self.options[self.entries.index('DIMENSIONAL_SPLITTING')] = ['NO']
             self.default[self.entries.index('DIMENSIONAL_SPLITTING')] = 'NO'
             
 
         if self.flag_dict['WITH-FD']:
             self.options[self.entries.index('PHYSICS')] = ['HD', 'MHD']
             self.options[self.entries.index('GEOMETRY')] = ['CARTESIAN']
             self.options[self.entries.index('RECONSTRUCTION')] = ['WENO3_FD', 'WENOZ_FD', 'MP5_FD','LIMO3_FD']
             self.default[self.entries.index('RECONSTRUCTION')] = 'WENOZ_FD'
             self.options[self.entries.index('TIME_STEPPING')] = ['RK3','SSP_RK4']
             self.default[self.entries.index('TIME_STEPPING')] = 'RK3'
             
 
         if self.flag_dict['WITH-SB']:
             self.options[self.entries.index('PHYSICS')] = ['HD', 'MHD']
             self.default[self.entries.index('PHYSICS')] = 'MHD'
             self.options[self.entries.index('DIMENSIONS')] = ['2', '3']
             self.default[self.entries.index('DIMENSIONS')] = '2'
             self.options[self.entries.index('COMPONENTS')] = ['2', '3']
             self.default[self.entries.index('COMPONENTS')] = '2'
             self.options[self.entries.index('BODY_FORCE')] = ['VECTOR', 'POTENTIAL', '(VECTOR+POTENTIAL)']
             self.default[self.entries.index('BODY_FORCE')] = 'VECTOR'
 
 

Here is the caller graph for this function:

def define_problem.DefineProblem.AppendAdditionalFiles ( self )

Adds additional object files based on
modular defintions and requirements.

Definition at line 391 of file define_problem.without_userdef_constants.py.

     def AppendAdditionalFiles(self):
         """
         Adds additional object files based on
         modular defintions and requirements. 
         """
         interp_mode = self.default[self.entries.index('INTERPOLATION')]
 
         if interp_mode == 'LINEAR':
             self.additional_files.append('plm_states.o')
         elif interp_mode == 'PARABOLIC':
             self.additional_files.append('ppm_states.o')
             self.additional_files.append('ppm_coeffs.o')
             self.header_files.append('ppm_coeffs.h')
         elif interp_mode in ['FLAT', 'LimO3', 'WENO3']:
             self.additional_files.append('states_'+interp_mode.lower()+'.o')

Here is the call graph for this function:

def define_problem.DefineProblem.AppendAdditionalFiles ( self )

Adds additional object files based on
modular defintions and requirements.

Definition at line 420 of file define_problem.py.

     def AppendAdditionalFiles(self):
         """
         Adds additional object files based on
         modular defintions and requirements. 
         """
         interp_mode = self.default[self.entries.index('RECONSTRUCTION')]
 
         if interp_mode == 'LINEAR':
             self.additional_files.append('plm_states.o')
         elif interp_mode == 'PARABOLIC':
             self.additional_files.append('ppm_states.o')
             self.additional_files.append('ppm_coeffs.o')
             self.header_files.append('ppm_coeffs.h')
         elif interp_mode in ['FLAT', 'LimO3', 'WENO3']:
             self.additional_files.append(interp_mode.lower()+'_states.o')

Here is the caller graph for this function:

def define_problem.DefineProblem.AppendPlutoPathAndFlags ( self )

Adds additional C flags and path to 'makefile' based on
modular defintions and requirements.

Definition at line 447 of file define_problem.without_userdef_constants.py.

     def AppendPlutoPathAndFlags(self):
         """
         Adds additional C flags and path to 'makefile' based on
         modular defintions and requirements. 
         """
         self.pluto_path.append(self.phymodule+'/')
 
         dis_eff = ['Thermal_Conduction', 'Viscosity']
         for de in dis_eff:
             if de.upper() in self.mod_entries and self.mod_default[self.mod_entries.index(de.upper())] != 'NO':
                 self.pluto_path.append(de+'/')
         
         if self.phymodule == 'MHD' or self.phymodule == 'RMHD':
             divb_mode = self.mod_default[self.mod_entries.index('MHD_FORMULATION')]
             if divb_mode == 'CONSTRAINED_TRANSPORT':
                 self.pluto_path.append('MHD/CT/')
             elif divb_mode == 'DIV_CLEANING':
                 self.pluto_path.append('MHD/GLM/')
             else:
                 pass
 
             if self.phymodule == 'MHD' and self.mod_default[self.mod_entries.index('RESISTIVE_MHD')] != 'NO':
                 self.pluto_path.append('MHD/Resistive/')
 
         if self.flag_dict['WITH-SB']:
             self.pluto_path.append('MHD/ShearingBox/')
             self.additional_flags.append(' -DSHEARINGBOX')
             
         if self.flag_dict['WITH-FARGO']:
             self.pluto_path.append('Fargo/')
             self.additional_flags.append(' -DFARGO')
 
         if self.flag_dict['WITH-FD']:
             self.additional_flags.append(' -DFINITE_DIFFERENCE')
 
         cool_mode = self.default[self.entries.index('COOLING')]
         if cool_mode != 'NO':
             if cool_mode == 'TABULATED':
                 self.pluto_path.append('Cooling/Tab/')
             elif cool_mode == 'POWER_LAW':
                 self.pluto_path.append('Cooling/Power_Law/')
             else:
                 self.pluto_path.append('Cooling/'+ cool_mode +'/')
 
         if 'EOS' in self.mod_entries:
             if 'PVTE_LAW' in self.mod_default:
                 tmp1 = 'PVTE'
             else:
                 tmp1 = self.eos[0]+self.eos[1:].lower()
             self.pluto_path.append('EOS/'+tmp1+'/')
 

Here is the call graph for this function:

def define_problem.DefineProblem.AppendPlutoPathAndFlags ( self )

Adds additional C flags and path to 'makefile' based on
modular defintions and requirements.

Definition at line 478 of file define_problem.py.

     def AppendPlutoPathAndFlags(self):
         """
         Adds additional C flags and path to 'makefile' based on
         modular defintions and requirements. 
         """
         self.pluto_path.append(self.phymodule+'/')
 
         dis_eff = ['Dust','Thermal_Conduction', 'Viscosity']
         for de in dis_eff:
             if de.upper() in self.mod_entries and self.mod_default[self.mod_entries.index(de.upper())] != 'NO':
                 self.pluto_path.append(de+'/')
         
         if self.phymodule == 'MHD' or self.phymodule == 'RMHD':
             divb_mode = self.mod_default[self.mod_entries.index('DIVB_CONTROL')]
             if divb_mode == 'CONSTRAINED_TRANSPORT':
                 self.pluto_path.append('MHD/CT/')
             elif divb_mode == 'DIV_CLEANING':
                 self.pluto_path.append('MHD/GLM/')
             else:
                 pass
 
             if self.phymodule == 'MHD' and self.mod_default[self.mod_entries.index('RESISTIVITY')] != 'NO':
                 self.pluto_path.append('MHD/Resistivity/')
 
         if self.flag_dict['WITH-SB']:
             self.pluto_path.append('MHD/ShearingBox/')
             self.additional_flags.append(' -DSHEARINGBOX')
             
         if self.flag_dict['WITH-FARGO']:
             self.pluto_path.append('Fargo/')
             self.additional_flags.append(' -DFARGO')
 
         if self.flag_dict['WITH-FD']:
             self.additional_flags.append(' -DFINITE_DIFFERENCE')
 
         cool_mode = self.default[self.entries.index('COOLING')]
         if cool_mode != 'NO':
             if cool_mode == 'TABULATED':
                 self.pluto_path.append('Cooling/TABULATED/')
             elif cool_mode == 'POWER_LAW':
                 self.pluto_path.append('Cooling/Power_Law/')
             else:
                 self.pluto_path.append('Cooling/'+ cool_mode +'/')
 
         if 'EOS' in self.mod_entries:
             if 'PVTE_LAW' in self.mod_default:
                 tmp1 = 'PVTE'
             else:
                 tmp1 = self.eos[0]+self.eos[1:].lower()
             self.pluto_path.append('EOS/'+tmp1+'/')
 

Here is the caller graph for this function:

def define_problem.DefineProblem.ChkCompatiblity ( self )

Definition at line 108 of file define_problem.py.

     def ChkCompatiblity(self):
           oldKeys_ = ['INTERPOLATION','MHD_FORMULATION','RESISTIVE_MHD']
           replaceKeys_ = ['RECONSTRUCTION','DIVB_CONTROL','RESISTIVITY']
           if (os.path.exists(self.work_dir+'/definitions.h')):
             pf = pfIO.PlutoFiles(self.work_dir+'/definitions.h')
             for i in range(len(oldKeys_)):
                 pf.ReplaceWord(oldKeys_[i], replaceKeys_[i])
     

def define_problem.DefineProblem.GenerateOptionsList ( self )

Creates a default option list.

This method of class DefineProblem will create a
default valued options list for each entry in the
entries list. These are essentially the options
that will be browsed in the Pluto Setup Menu.

Definition at line 115 of file define_problem.without_userdef_constants.py.

     def GenerateOptionsList(self):
         """Creates a default option list.
 
         This method of class DefineProblem will create a
         default valued options list for each entry in the
         entries list. These are essentially the options
         that will be browsed in the Pluto Setup Menu.
         """
         phylist = ['ADVECTION','HD','RHD','MHD','RMHD']
         dimlist = ['1','2','3']
         comlist = ['1','2','3']
         geolist = ['CARTESIAN','CYLINDRICAL','POLAR','SPHERICAL']
         bfolist = ['NO','VECTOR', 'POTENTIAL', '(VECTOR+POTENTIAL)']
         coolist = ['NO','POWER_LAW','TABULATED','SNEq','MINEq','H2_COOL', 'KROME']
         #parlist = ['NO','YES']
         intlist = ['FLAT','LINEAR','LimO3','WENO3','PARABOLIC']
         tmslist = ['EULER','RK2','RK3','HANCOCK','CHARACTERISTIC_TRACING']
         dislist = ['YES','NO']
         ntrlist = ['%d'%n for n in range(5)]
         udplist = ['%d'%n for n in range(32)]
         udclist = ['%d'%n for n in range(32)]
 
         self.options = [phylist, dimlist, comlist, geolist, bfolist,
                         coolist, intlist, tmslist,
                         dislist, ntrlist, udplist,
                         udclist]
 

Here is the call graph for this function:

def define_problem.DefineProblem.GenerateOptionsList ( self )

Creates a default option list.

This method of class DefineProblem will create a
default valued options list for each entry in the
entries list. These are essentially the options
that will be browsed in the Pluto Setup Menu.

Definition at line 116 of file define_problem.py.

     def GenerateOptionsList(self):
         """Creates a default option list.
 
         This method of class DefineProblem will create a
         default valued options list for each entry in the
         entries list. These are essentially the options
         that will be browsed in the Pluto Setup Menu.
         """
         phylist = ['ADVECTION','HD','RHD','MHD','RMHD']
         dimlist = ['1','2','3']
         comlist = ['1','2','3']
         geolist = ['CARTESIAN','CYLINDRICAL','POLAR','SPHERICAL']
         bfolist = ['NO','VECTOR', 'POTENTIAL', '(VECTOR+POTENTIAL)']
         coolist = ['NO','POWER_LAW','TABULATED','SNEq','MINEq','H2_COOL']
         #parlist = ['NO','YES']
         intlist = ['FLAT','LINEAR','LimO3','WENO3','PARABOLIC']
         tmslist = ['EULER','RK2','RK3','HANCOCK','CHARACTERISTIC_TRACING']
         dislist = ['YES','NO']
         ntrlist = ['%d'%n for n in range(9)]
         udplist = ['%d'%n for n in range(32)]
         udclist = ['%d'%n for n in range(32)]
 
         self.options = [phylist, dimlist, comlist, geolist, bfolist,
                         coolist, intlist, tmslist,
                         dislist, ntrlist, udplist,
                         udclist]
 

Here is the caller graph for this function:

def define_problem.DefineProblem.NonUserFriendlyConst ( self )

Sets the non-user friendly constants.

Definition at line 343 of file define_problem.without_userdef_constants.py.

     def NonUserFriendlyConst(self):
         """
         Sets the non-user friendly constants.
         """
         tmplist1 = ['INITIAL_SMOOTHING', 'WARNING_MESSAGES', 'PRINT_TO_FILE', 'INTERNAL_BOUNDARY', 'SHOCK_FLATTENING']
         tmplist2 = len(tmplist1)*['NO']
         
         if self.flag_dict['WITH-CHOMBO']:
             tmplist1 += ['CHOMBO_EN_SWITCH','CHOMBO_REF_VAR','CHOMBO_LOGR']
             tmplist2 += [              'NO',           'ENG',       'NO']  
 
         if not self.flag_dict['WITH-FD']:
             tmplist1 = tmplist1 + ['ARTIFICIAL_VISCOSITY', 'CHAR_LIMITING', 'LIMITER']
             tmplist2 = tmplist2 + ['NO', 'NO', 'DEFAULT']
             
         if 'MHD_FORMULATION' in self.mod_entries:
             divb_mode = self.mod_default[self.mod_entries.index('MHD_FORMULATION')]
             if divb_mode == 'CONSTRAINED_TRANSPORT':
                 tmplist1 = tmplist1 + ['CT_EMF_AVERAGE', 'CT_EN_CORRECTION', 'ASSIGN_VECTOR_POTENTIAL']
                 tmplist2 = tmplist2 + ['UCT_HLL', 'NO', 'YES']
             else:
                 tmplist1 = tmplist1 + ['ASSIGN_VECTOR_POTENTIAL']
                 tmplist2 = tmplist2 + ['NO']
             
             if not self.flag_dict['WITH-CHOMBO']:
                 tmplist1 = tmplist1 + ['UPDATE_VECTOR_POTENTIAL']
                 tmplist2 = tmplist2 + ['NO']
 
         if 'HANCOCK' in self.default:
             if (self.phymodule == 'RMHD'):
                 tmplist1 = tmplist1 + ['PRIMITIVE_HANCOCK']
                 tmplist2 = tmplist2 + ['NO']
             else:
                 tmplist1 = tmplist1 + ['PRIMITIVE_HANCOCK']
                 tmplist2 = tmplist2 + ['YES']
         
         if 'SUPER_TIME_STEPPING' in self.mod_default:
             tmplist1 = tmplist1 + ['STS_nu']
             tmplist2 = tmplist2 + ['0.01']
 
         longword = max(len(w) for w in tmplist1)
         
         if (os.path.exists(self.work_dir+'/definitions.h')):
             pf = pfIO.PlutoFiles(self.work_dir+'/definitions.h')
             pf.UpdateListFromFile(tmplist1, tmplist2)
             
         self.non_usfr = ['#define  '+tmplist1[i].ljust(longword+3)+tmplist2[i]+'\n' for i in range(len(tmplist1))]
 

Here is the call graph for this function:

def define_problem.DefineProblem.NonUserFriendlyConst ( self )

Sets the non-user friendly constants.

Definition at line 375 of file define_problem.py.

     def NonUserFriendlyConst(self):
         """
         Sets the non-user friendly constants.
         """
         tmplist1 = ['INITIAL_SMOOTHING', 'WARNING_MESSAGES', 'PRINT_TO_FILE',
             'INTERNAL_BOUNDARY', 'SHOCK_FLATTENING']
         tmplist2 = len(tmplist1)*['NO']
         

Here is the caller graph for this function:

def define_problem.DefineProblem.ProcessHDModule ( self )

Provides entries, options and defaults specific to Hydro Module.
Also updates them accordingly if required by flags.

Definition at line 216 of file define_problem.without_userdef_constants.py.

     def ProcessHDModule(self):
         """
         Provides entries, options and defaults specific to Hydro Module.
         Also updates them accordingly if required by flags.
         """
         self.entries_HD = ['EOS', 'ENTROPY_SWITCH', 'THERMAL_CONDUCTION', 'VISCOSITY', 'ROTATING_FRAME']
         self.default_HD = ['IDEAL', 'NO', 'NO', 'NO', 'NO']
         self.options_HD = [['IDEAL','PVTE_LAW','ISOTHERMAL'], ['NO','YES'], ['NO','EXPLICIT','SUPER_TIME_STEPPING'],
                             ['NO','EXPLICIT','SUPER_TIME_STEPPING'], ['NO','YES']]
     
         if self.flag_dict['WITH-CHOMBO']:
             self.options_HD[2] = ['NO','EXPLICIT']
             self.options_HD[3] = ['NO','EXPLICIT']
 

Here is the call graph for this function:

def define_problem.DefineProblem.ProcessHDModule ( self )

Provides entries, options and defaults specific to Hydro Module.
Also updates them accordingly if required by flags.

Definition at line 217 of file define_problem.py.

     def ProcessHDModule(self):
         """
         Provides entries, options and defaults specific to Hydro Module.
         Also updates them accordingly if required by flags.
         """
         self.entries_HD = ['EOS', 'ENTROPY_SWITCH',
                            'THERMAL_CONDUCTION',
                            'VISCOSITY',
                            'ROTATING_FRAME']
         self.default_HD = ['IDEAL', 'NO',
                            'NO',
                            'NO',
                            'NO']
         self.options_HD = [['IDEAL','PVTE_LAW','ISOTHERMAL'],
 #                           ['NO','YES'],
                             ['NO','SELECTIVE','ALWAYS','CHOMBO_REGRID'],
                            ['NO','EXPLICIT','SUPER_TIME_STEPPING'],
                            ['NO','EXPLICIT','SUPER_TIME_STEPPING'],
                            ['NO','YES']]
     
         if self.flag_dict['WITH-CHOMBO']: # Chombo does not support STS at the
                                           # moment. Only explicit allowed with Chombo
             i =  self.entries_HD.index('THERMAL_CONDUCTION')
             self.options_HD[i] = ['NO','EXPLICIT']
             i =  self.entries_HD.index('VISCOSITY')
             self.options_HD[i] = ['NO','EXPLICIT']
 

Here is the caller graph for this function:

def define_problem.DefineProblem.ProcessKROMEModule ( self )

Provides entries, options, and defaults for the KROME cooling module.

Definition at line 278 of file define_problem.without_userdef_constants.py.

     def ProcessKROMEModule(self):
         """
         Provides entries, options, and defaults for the KROME cooling module.
         """
         netwrkfiles = os.listdir(self.krome_dir+'/networks/')
         self.entries_KROME = ['NETWORK_FILE', 'USE_N','COOLING_TYPE', 'HEATING_TYPE', 'GAMMA_TYPE']
         self.default_KROME = [netwrkfiles[0], 'NO', 'NONE', 'NONE', 'DEFAULT']
         self.options_KROME = [netwrkfiles, ['NO', 'YES'], [ 'NONE', 'H2', 'ATOMIC', 'Z'], ['NONE', 'COMPRESS', 'PHOTO', 'XRAY'], ['DEFAULT','FULL', 'ROT', 'VIB', 'EXACT', 'REDUCED']]
         
         

def define_problem.DefineProblem.ProcessMHDModule ( self )

Provides entries, options and defaults specific to Magneto-
Hydro Module.Also updates them accordingly if required by flags.

Definition at line 239 of file define_problem.without_userdef_constants.py.

     def ProcessMHDModule(self):
         """
         Provides entries, options and defaults specific to Magneto-
         Hydro Module.Also updates them accordingly if required by flags.
         """
         self.entries_MHD = ['EOS', 'ENTROPY_SWITCH', 'MHD_FORMULATION', 'BACKGROUND_FIELD',
                             'RESISTIVE_MHD', 'THERMAL_CONDUCTION', 'VISCOSITY', 'ROTATING_FRAME']
         self.default_MHD = ['IDEAL','NO','EIGHT_WAVES','NO','NO','NO','NO','NO']
         self.options_MHD = [['IDEAL','PVTE_LAW','ISOTHERMAL'], ['NO','YES'],
                             ['NONE','EIGHT_WAVES','DIV_CLEANING','CONSTRAINED_TRANSPORT'],
                             ['NO','YES'],['NO','EXPLICIT', 'SUPER_TIME_STEPPING'],
                             ['NO','EXPLICIT', 'SUPER_TIME_STEPPING'],['NO','EXPLICIT', 'SUPER_TIME_STEPPING'],['NO','YES']]
         
         if self.flag_dict['WITH-CHOMBO']:
             self.options_MHD[2] = ['NONE','EIGHT_WAVES','DIV_CLEANING']
             self.options_MHD[4] = ['NO','EXPLICIT']
             self.options_MHD[5] = ['NO','EXPLICIT']
             self.options_MHD[6] = ['NO','EXPLICIT']
 
         if self.flag_dict['WITH-FD']:
             self.options_MHD[2] = ['NONE','EIGHT_WAVES','DIV_CLEANING']
 
         if self.flag_dict['WITH-SB'] or self.flag_dict['WITH-FARGO']:
             self.options_MHD[2] = ['CONSTRAINED_TRANSPORT']
             self.default_MHD[2] = 'CONSTRAINED_TRANSPORT'
     

Here is the call graph for this function:

def define_problem.DefineProblem.ProcessMHDModule ( self )

Provides entries, options and defaults specific to Magneto-
Hydro Module.Also updates them accordingly if required by flags.

Definition at line 255 of file define_problem.py.

     def ProcessMHDModule(self):
         """
         Provides entries, options and defaults specific to Magneto-
         Hydro Module.Also updates them accordingly if required by flags.
         """
         self.entries_MHD = ['EOS', 'ENTROPY_SWITCH', 'DIVB_CONTROL', 'BACKGROUND_FIELD',
                             'RESISTIVITY', 'THERMAL_CONDUCTION', 'VISCOSITY', 'ROTATING_FRAME']
         self.default_MHD = ['IDEAL','NO','EIGHT_WAVES','NO','NO','NO','NO','NO']
         self.options_MHD = [['IDEAL','PVTE_LAW','ISOTHERMAL'],
 #                            ['NO','YES'],
                             ['NO','SELECTIVE','ALWAYS','CHOMBO_REGRID'],
                             ['NO','EIGHT_WAVES','DIV_CLEANING','CONSTRAINED_TRANSPORT'],
                             ['NO','YES'],['NO','EXPLICIT', 'SUPER_TIME_STEPPING'],
                             ['NO','EXPLICIT', 'SUPER_TIME_STEPPING'],['NO','EXPLICIT', 'SUPER_TIME_STEPPING'],['NO','YES']]
         
         if self.flag_dict['WITH-CHOMBO']:
             indx_ = self.entries_MHD.index('DIVB_CONTROL')
             self.options_MHD[indx_] = ['NO','EIGHT_WAVES','DIV_CLEANING']
             indx_ = self.entries_MHD.index('RESISTIVITY')
             self.options_MHD[indx_] = ['NO','EXPLICIT']
             indx_ = self.entries_MHD.index('THERMAL_CONDUCTION')
             self.options_MHD[indx_] = ['NO','EXPLICIT']
             indx_ = self.entries_MHD.index('VISCOSITY')
             self.options_MHD[indx_] = ['NO','EXPLICIT']
 
         if self.flag_dict['WITH-FD']:
             indx_ = self.entries_MHD.index('DIVB_CONTROL')
             self.options_MHD[indx_] = ['NO','EIGHT_WAVES','DIV_CLEANING']
 
         if self.flag_dict['WITH-SB'] or self.flag_dict['WITH-FARGO']:
             indx_ = self.entries_MHD.index('DIVB_CONTROL')
             self.options_MHD[indx_] = ['CONSTRAINED_TRANSPORT']
             self.default_MHD[indx_] = 'CONSTRAINED_TRANSPORT'
     

Here is the caller graph for this function:

def define_problem.DefineProblem.ProcessRHDModule ( self )

Provides entries, options and defaults specific to Relativistic
Hydro Module. Also updates them accordingly if required by flags.

Definition at line 230 of file define_problem.without_userdef_constants.py.

     def ProcessRHDModule(self):
         """
         Provides entries, options and defaults specific to Relativistic
         Hydro Module. Also updates them accordingly if required by flags.
         """
         self.entries_RHD = ['EOS', 'ENTROPY_SWITCH', 'USE_FOUR_VELOCITY']
         self.default_RHD = ['IDEAL', 'NO', 'NO']
         self.options_RHD = [['IDEAL','TAUB'], ['NO','YES'],  ['NO','YES']]
 

Here is the call graph for this function:

def define_problem.DefineProblem.ProcessRHDModule ( self )

Provides entries, options and defaults specific to Relativistic
Hydro Module. Also updates them accordingly if required by flags.

Definition at line 244 of file define_problem.py.

     def ProcessRHDModule(self):
         """
         Provides entries, options and defaults specific to Relativistic
         Hydro Module. Also updates them accordingly if required by flags.
         """
         self.entries_RHD = ['EOS', 'ENTROPY_SWITCH']
         self.default_RHD = ['IDEAL', 'NO', 'NO']
         self.options_RHD = [['IDEAL','TAUB'],
 #                            ['NO','YES']]
                             ['NO','SELECTIVE','ALWAYS','CHOMBO_REGRID']]
 

Here is the caller graph for this function:

def define_problem.DefineProblem.ProcessRMHDModule ( self )

Provides entries, options and defaults specific to Relativisitc
Magneto-Hydro Module.Also updates them accordingly if required by flags.

Definition at line 265 of file define_problem.without_userdef_constants.py.

     def ProcessRMHDModule(self):
         """
         Provides entries, options and defaults specific to Relativisitc
         Magneto-Hydro Module.Also updates them accordingly if required by flags.
         """
         self.entries_RMHD = ['EOS', 'ENTROPY_SWITCH','MHD_FORMULATION' ]
         self.default_RMHD = ['IDEAL', 'NO', 'NONE']
         self.options_RMHD = [['IDEAL', 'TAUB'], ['NO','YES'],
                            ['NONE','EIGHT_WAVES','DIV_CLEANING','CONSTRAINED_TRANSPORT']]
 
         if self.flag_dict['WITH-CHOMBO']:
             self.options_RMHD[2] = ['NONE','EIGHT_WAVES','DIV_CLEANING']
 

Here is the call graph for this function:

def define_problem.DefineProblem.ProcessRMHDModule ( self )

Provides entries, options and defaults specific to Relativisitc
Magneto-Hydro Module.Also updates them accordingly if required by flags.

Definition at line 289 of file define_problem.py.

     def ProcessRMHDModule(self):
         """
         Provides entries, options and defaults specific to Relativisitc
         Magneto-Hydro Module.Also updates them accordingly if required by flags.
         """
         self.entries_RMHD = ['EOS', 'ENTROPY_SWITCH','DIVB_CONTROL' ]
         self.default_RMHD = ['IDEAL', 'NO', 'NO']
         self.options_RMHD = [['IDEAL', 'TAUB'],
 #                            ['NO','YES'],
                              ['NO','SELECTIVE','ALWAYS','CHOMBO_REGRID'],
                              ['NO','EIGHT_WAVES','DIV_CLEANING','CONSTRAINED_TRANSPORT']]
 
         if self.flag_dict['WITH-CHOMBO']:
             indx_ = self.entries_RMHD.index('DIVB_CONTROL')
             self.options_RMHD[indx_] = ['NO','EIGHT_WAVES','DIV_CLEANING']
 

Here is the caller graph for this function:

def define_problem.DefineProblem.ProcessUserDefConst ( self )

Sets the Userdefined Constants.

Definition at line 315 of file define_problem.without_userdef_constants.py.

     def ProcessUserDefConst(self):
         """
         Sets the Userdefined Constants.
         """
         if (os.path.exists(self.work_dir+'/definitions.h')):
             pf = pfIO.PlutoFiles(self.work_dir+'/definitions.h')
             scrh_beg = pf.LocateString('User_Constants_Beg')
             k_beg   = scrh_beg[0][0]+1
             scrh_end = pf.LocateString('User_Constants_End')
             k_end   = scrh_end[0][0]-1
             const_lines = pf.ReadLines(k_beg, k_end)
             print const_lines
             for n in range(len(const_lines)):
                 x = const_lines[n].split()
                 try:                
                     x[0] == '#define'
                 except IndexError: 
                     pass
                 else:
                     if (x[0] == '#define'):
                         self.udef_const.append(x[1])
                         self.udef_const_vals.append(x[2])
                     else:
                         continue
             
                 
         
 

Here is the call graph for this function:

def define_problem.DefineProblem.ProcessUserDefConst ( self )

Sets the Userdefined Constants.

Definition at line 336 of file define_problem.py.

     def ProcessUserDefConst(self):
         """
         Sets the Userdefined Constants.
         """
         if (os.path.exists(self.work_dir+'/definitions.h')):
             pf = pfIO.PlutoFiles(self.work_dir+'/definitions.h')
             old_beg_scrh = pf.LocateString('symbolic')
             try:
                 old_beg_scrh[0][0]
             except IndexError:
                 pass
             else:
                 del_indx = pf.LocateString('USER_DEF_CONSTANTS')
                 pf.DeleteLines(del_indx[0][0], del_indx[0][0])
                 old_beg_scrh = pf.LocateString('symbolic')
                 pf.ReplaceLine('/* [Beg] user-defined constants (do not change this line) */', old_beg_scrh[0][0])
                 old_end_scrh = pf.LocateString('supplementary')
                 pf.InsertLine('/* [End] user-defined constants (do not change this line) */', old_end_scrh[0][0] - 1)
                 
             scrh_beg = pf.LocateString('[Beg]')
             k_beg   = scrh_beg[0][0]+1
             scrh_end = pf.LocateString('[End]')
             k_end   = scrh_end[0][0]-1
             const_lines = pf.ReadLines(k_beg, k_end)
             #print const_lines
             for n in range(len(const_lines)):
                 x = const_lines[n].split()
                 try:                
                     x[0] == '#define'
                 except IndexError: 
                     pass
                 else:
                     if (x[0] == '#define'):
                         self.udef_const.append(x[1])
                         self.udef_const_vals.append(x[2])
                     else:
                         continue
             
 

Here is the caller graph for this function:

def define_problem.DefineProblem.ProcessUserDefPara ( self )

Sets the Userdefined parameters

Definition at line 288 of file define_problem.without_userdef_constants.py.

     def ProcessUserDefPara(self):
         """
         Sets the Userdefined parameters
         """
         self.udef_params = ['USER_PAR_%.2d'%i for i in range(self.nparam)]
         if (os.path.exists(self.work_dir+'/definitions.h')):
             pf = pfIO.PlutoFiles(self.work_dir+'/definitions.h')
             scrh = pf.LocateString('parameters')
             k0   = scrh[0][0] + 2
             par_lines = pf.ReadLines(k0, k0 + self.nparam)
             for n in range(self.nparam):
                 try:
                     x = par_lines[n].split()
                     x[0] == '#define'
                 except IndexError:
                     pass
                 else:
                     if (x[0] == "#define"):
                         self.udef_params[n] = x[1]
                     else:          
                         break;
                         
         if self.auto_update == 0:
             menu.SetTitle ("User-defined Parameters")
             par_entries = ['%d'%i for i in range(self.nparam)]
             menu.Insert(par_entries,self.udef_params)
     

Here is the call graph for this function:

def define_problem.DefineProblem.ProcessUserDefPara ( self )

Sets the Userdefined parameters

Definition at line 305 of file define_problem.py.

     def ProcessUserDefPara(self):
         """
         Sets the Userdefined parameters
         """
         self.udef_params = ['USER_PAR_%.2d'%i for i in range(self.nparam)]
         if (os.path.exists(self.work_dir+'/definitions.h')):
             pf = pfIO.PlutoFiles(self.work_dir+'/definitions.h')
             scrh = pf.LocateString('parameters')
             k0   = scrh[0][0] + 2
             par_lines = pf.ReadLines(k0, k0 + self.nparam)
             for n in range(self.nparam):
                 try:
                     x = par_lines[n].split()
                     x[0] == '#define'
                 except IndexError:
                     pass
                 else:
                     if (x[0] == "#define"):
                         self.udef_params[n] = x[1]
                     else:          
                         break;
                         
         if self.auto_update == 0:
             menu.SetTitle ("User-defined Parameters")
             par_entries = ['%d'%i for i in range(self.nparam)]
             menu.Insert(par_entries,self.udef_params)
 
 
 
     
         

Here is the caller graph for this function:

def define_problem.DefineProblem.ReadOrBrowse	(	self,
		Ents = `None`,
		Opts = `None`,
		Defs = `None`,
		MenuTitle = `None`
	)

Reads or Browses the entries, options and defaults to create header file.

This method either reads the already exsisting definitions.h file or browses
throught the three lists which are provided as inputs.

**Inputs**:
  1. Ents = List of entries. [None]
  2. Opts = List of options corresponding to each member in Ents [None]
  3. Defs = List of default value from Opts corresponding to each member in Ents [None]
  4. MenuTitle = Title for the Menu to be Browsed [None]

Definition at line 189 of file define_problem.without_userdef_constants.py.

     def ReadOrBrowse(self, Ents=None, Opts=None, Defs=None, MenuTitle=None):
         """Reads or Browses the entries, options and defaults to create header file.
 
         This method either reads the already exsisting definitions.h file or browses
         throught the three lists which are provided as inputs.
 
         **Inputs**:
           1. Ents = List of entries. [None]
           2. Opts = List of options corresponding to each member in Ents [None]
           3. Defs = List of default value from Opts corresponding to each member in Ents [None]
           4. MenuTitle = Title for the Menu to be Browsed [None]
         """
         if (os.path.exists(self.work_dir+'/definitions.h')):
             pf = pfIO.PlutoFiles(self.work_dir+'/definitions.h')
             pf.UpdateListFromFile(Ents, Defs)
         for i in range(len(Ents)):
         if Defs[i] not in Opts[i]:
             Defs[i] = Opts[i][0]
         else:
             pass
 
         # Provides Browsing options using the menu file in case of no automatic update flag.
         if self.auto_update == 0:
             selection = ''
             menu.SetTitle(MenuTitle)
             selection = menu.Browse(Ents, default=Defs, options=Opts)
         

Here is the call graph for this function:

def define_problem.DefineProblem.ReadOrBrowse	(	self,
		Ents = `None`,
		Opts = `None`,
		Defs = `None`,
		MenuTitle = `None`
	)

Reads or Browses the entries, options and defaults to create header file.

This method either reads the already exsisting definitions.h file or browses
throught the three lists which are provided as inputs.

**Inputs**:
  1. Ents = List of entries. [None]
  2. Opts = List of options corresponding to each member in Ents [None]
  3. Defs = List of default value from Opts corresponding to each member in Ents [None]
  4. MenuTitle = Title for the Menu to be Browsed [None]

Definition at line 190 of file define_problem.py.

     def ReadOrBrowse(self, Ents=None, Opts=None, Defs=None, MenuTitle=None):
         """Reads or Browses the entries, options and defaults to create header file.
 
         This method either reads the already exsisting definitions.h file or browses
         throught the three lists which are provided as inputs.
 
         **Inputs**:
           1. Ents = List of entries. [None]
           2. Opts = List of options corresponding to each member in Ents [None]
           3. Defs = List of default value from Opts corresponding to each member in Ents [None]
           4. MenuTitle = Title for the Menu to be Browsed [None]
         """
         if (os.path.exists(self.work_dir+'/definitions.h')):
             pf = pfIO.PlutoFiles(self.work_dir+'/definitions.h')
             pf.UpdateListFromFile(Ents, Defs)
         for i in range(len(Ents)):
         if Defs[i] not in Opts[i]:
             Defs[i] = Opts[i][0]
         else:
             pass
 
         # Provides Browsing options using the menu file in case of no automatic update flag.
         if self.auto_update == 0:
             selection = ''
             menu.SetTitle(MenuTitle)
             selection = menu.Browse(Ents, default=Defs, options=Opts)
         

Here is the call graph for this function:

Here is the caller graph for this function:

def define_problem.DefineProblem.UpdatePlutoIni ( self )

Updates pluto.ini file with values of UserDefined Parameters

Definition at line 498 of file define_problem.without_userdef_constants.py.

     def UpdatePlutoIni(self):
         """
         Updates pluto.ini file with values of UserDefined Parameters
         """
         pf = pfIO.PlutoFiles(self.work_dir+'/pluto.ini')
         scrh = pf.LocateString('[Parameters]')
         try:
             scrh[0]
         except IndexError:
             print "Parameters keyword not found in pluto.ini"
             sys.exit()
         else:
             pass
         
         ipos = scrh[0][0] + 2
         tmplist1 = pf.ReadLines(ipos,100)
         paradict = {}
         cmms = []
         for x in tmplist1:
             if (len(x.split()) == 0): continue  # skip blank lines 
             paradict.update({x.split()[0]:x.split()[1]})
             try:
                 cmmval = x.split()[2]
             except IndexError:
                 cmms.append('')
                 continue
             else:
                 if cmmval == '#' or cmmval.startswith('#'):
                     cmms.append(' '.join(x.split()[2:]))
                 else:
                     cmms.append('')
 
         for x in self.udef_params:
             if x in paradict.keys():
                 pf.InsertLine(x.ljust(21) + paradict[x] +'  '+cmms[self.udef_params.index(x)]+'\n', ipos)
             else:
                 try:
                     cmms[self.udef_params.index(x)]
                 except IndexError:
                     pf.InsertLine(x.ljust(21) + '0.0' + '\n', ipos)
                 else:
                     pf.InsertLine(x.ljust(21) + '0.0'+'  '+cmms[self.udef_params.index(x)]+ '\n', ipos)
             ipos = ipos + 1
         pf.DeleteLines(ipos,ipos+100)
 

Here is the call graph for this function:

def define_problem.DefineProblem.UpdatePlutoIni ( self )

Updates pluto.ini file with values of UserDefined Parameters

Definition at line 529 of file define_problem.py.

     def UpdatePlutoIni(self):
         """
         Updates pluto.ini file with values of UserDefined Parameters
         """
         pf = pfIO.PlutoFiles(self.work_dir+'/pluto.ini')
         scrh = pf.LocateString('[Parameters]')
         try:
             scrh[0]
         except IndexError:
             print "Parameters keyword not found in pluto.ini"
             sys.exit()
         else:
             pass
         
         ipos = scrh[0][0] + 2
         tmplist1 = pf.ReadLines(ipos,100)
         paradict = {}
         cmms = []
         for x in tmplist1:
             if (len(x.split()) == 0): continue  # skip blank lines 
             paradict.update({x.split()[0]:x.split()[1]})
             try:
                 cmmval = x.split()[2]
             except IndexError:
                 cmms.append('')
                 continue
             else:
                 if cmmval == '#' or cmmval.startswith('#'):
                     cmms.append(' '.join(x.split()[2:]))
                 else:
                     cmms.append('')
 
         for x in self.udef_params:
             if x in paradict.keys():
                 pf.InsertLine(x.ljust(21) + paradict[x] +'  '+cmms[self.udef_params.index(x)]+'\n', ipos)
             else:
                 try:
                     cmms[self.udef_params.index(x)]
                 except IndexError:
                     pf.InsertLine(x.ljust(21) + '0.0' + '\n', ipos)
                 else:
                     pf.InsertLine(x.ljust(21) + '0.0'+'  '+cmms[self.udef_params.index(x)]+ '\n', ipos)
             ipos = ipos + 1
         pf.DeleteLines(ipos,ipos+100)
         

Here is the caller graph for this function:

def define_problem.DefineProblem.WriteDefFileList ( self )

Writes all modular entries, options, defaults into a list.

Definition at line 557 of file define_problem.without_userdef_constants.py.

     def WriteDefFileList(self):
         """
         Writes all modular entries, options, defaults into a list.
         """
         for x in self.entries:
             self.def_file_list.append('#define  '+x.ljust(21)+'   '+self.default[self.entries.index(x)]+'\n')
 
         self.def_file_list.append('\n/* -- physics dependent declarations -- */\n\n')
         self.phymodule = self.default[self.entries.index('PHYSICS')]
         tmp1 = ['entries_%s'%self.phymodule, 'default_%s'%self.phymodule]
         self.mod_entries = self.__getattribute__(tmp1[0])
         self.mod_default = self.__getattribute__(tmp1[1])
 
         for x in self.mod_entries:
             self.def_file_list.append('#define  '+x.ljust(21)+'   '+ self.mod_default[self.mod_entries.index(x)]+'\n')
 
         self.AppendAdditionalFiles()
         self.AppendPlutoPathAndFlags()
 
         # always insert user-defined paramters and constants sections
 
         self.def_file_list.append('\n/* -- user-defined parameters (labels) -- */\n\n')
         for x in self.udef_params:
             self.def_file_list.append('#define  '+x.ljust(21)+'   '+'%d'%self.udef_params.index(x)+'\n')
     
         self.UpdatePlutoIni()
     
         self.def_file_list.append('\n/* -- User_Constants_Beg --  DO NOT REMOVE THIS LINE*/\n\n')
         for i in range(len(self.udef_const)):
             self.def_file_list.append('#define  '+self.udef_const[i].ljust(21)+'   '+self.udef_const_vals[i]+'\n')
         self.def_file_list.append('\n/* -- User_Constants_End -- DO NOT REMOVE THIS LINE*/\n\n')
         
         self.def_file_list.append('\n/* -- supplementary constants (user editable) -- */ \n\n')
         self.NonUserFriendlyConst()
         for x in self.non_usfr:
             self.def_file_list.append(x)
         
Here is the call graph for this function:

def define_problem.DefineProblem.WriteDefFileList ( self )

Writes all modular entries, options, defaults into a list.

Definition at line 574 of file define_problem.py.

     def WriteDefFileList(self):
         """
         Writes all modular entries, options, defaults into a list.
         """
         for x in self.entries:
             self.def_file_list.append('#define  '+x.ljust(21)+'   '+self.default[self.entries.index(x)]+'\n')
 
         self.def_file_list.append('\n/* -- physics dependent declarations -- */\n\n')
         self.phymodule = self.default[self.entries.index('PHYSICS')]
         tmp1 = ['entries_%s'%self.phymodule, 'default_%s'%self.phymodule]
         self.mod_entries = self.__getattribute__(tmp1[0])
         self.mod_default = self.__getattribute__(tmp1[1])
 
         for x in self.mod_entries:
             self.def_file_list.append('#define  '+x.ljust(21)+'   '+ self.mod_default[self.mod_entries.index(x)]+'\n')
 
         self.AppendAdditionalFiles()
         self.AppendPlutoPathAndFlags()
 
         # always insert user-defined paramters and constants sections
 
         self.def_file_list.append('\n/* -- user-defined parameters (labels) -- */\n\n')
         for x in self.udef_params:
             self.def_file_list.append('#define  '+x.ljust(21)+'   '+'%d'%self.udef_params.index(x)+'\n')
     
         self.UpdatePlutoIni()
     
                 
         self.def_file_list.append('\n/* [Beg] user-defined constants (do not change this line) */\n\n')
         for i in range(len(self.udef_const)):
             self.def_file_list.append('#define  '+self.udef_const[i].ljust(21)+'   '+self.udef_const_vals[i]+'\n')
 
         self.def_file_list.append('\n/* [End] user-defined constants (do not change this line) */\n')
         
         self.def_file_list.append('\n/* -- supplementary constants (user editable) -- */ \n\n')
         self.NonUserFriendlyConst()
         for x in self.non_usfr:
             self.def_file_list.append(x)
         
         
         

Here is the caller graph for this function:

def define_problem.DefineProblem.WriteKromeOpts ( self )

Definition at line 543 of file define_problem.without_userdef_constants.py.

     def WriteKromeOpts(self):
         self.kromeoptstr = 'python '+self.krome_dir+'krome -n='+self.krome_dir+'networks/'+ self.default_KROME[self.entries_KROME.index('NETWORK_FILE')]
         if self.default_KROME[self.entries_KROME.index('USE_N')]:
             self.kromeoptstr += ' -useN'
 
         if self.default_KROME[self.entries_KROME.index('COOLING_TYPE')] != 'NONE':
             self.kromeoptstr += ' -cooling='+ self.default_KROME[self.entries_KROME.index('COOLING_TYPE')]
 
         if self.default_KROME[self.entries_KROME.index('HEATING_TYPE')] != 'NONE':
             self.kromeoptstr += ' -heating='+ self.default_KROME[self.entries_KROME.index('HEATING_TYPE')]
 
         if self.default_KROME[self.entries_KROME.index('GAMMA_TYPE')] != 'DEFAULT':
             self.kromeoptstr += ' -gamma='+ self.default_KROME[self.entries_KROME.index('GAMMA_TYPE')]
 

Member Data Documentation

define_problem.DefineProblem.additional_files

Definition at line 29 of file define_problem.py.

define_problem.DefineProblem.additional_flags

Definition at line 31 of file define_problem.py.

define_problem.DefineProblem.auto_update

Definition at line 27 of file define_problem.py.

tuple define_problem.DefineProblem.cmset = set(['CHARACTERISTIC_TRACING', 'HANCOCK'])

static

Definition at line 456 of file define_problem.py.

define_problem.DefineProblem.def_file_list

Definition at line 33 of file define_problem.py.

define_problem.DefineProblem.def_fname

Definition at line 28 of file define_problem.py.

define_problem.DefineProblem.default

Definition at line 41 of file define_problem.py.

define_problem.DefineProblem.default_HD

Definition at line 226 of file define_problem.py.

define_problem.DefineProblem.default_KROME

Definition at line 284 of file define_problem.without_userdef_constants.py.

define_problem.DefineProblem.default_MHD

Definition at line 262 of file define_problem.py.

define_problem.DefineProblem.default_RHD

Definition at line 250 of file define_problem.py.

define_problem.DefineProblem.default_RMHD

Definition at line 295 of file define_problem.py.

list define_problem.DefineProblem.divb_mode = self.mod_default[self.mod_entries.index('DIVB_CONTROL')]

static

Definition at line 392 of file define_problem.py.

define_problem.DefineProblem.entries

Definition at line 38 of file define_problem.py.

define_problem.DefineProblem.entries_HD

Definition at line 222 of file define_problem.py.

define_problem.DefineProblem.entries_KROME

Definition at line 283 of file define_problem.without_userdef_constants.py.

define_problem.DefineProblem.entries_MHD

Definition at line 260 of file define_problem.py.

define_problem.DefineProblem.entries_RHD

Definition at line 249 of file define_problem.py.

define_problem.DefineProblem.entries_RMHD

Definition at line 294 of file define_problem.py.

define_problem.DefineProblem.header_files

Definition at line 30 of file define_problem.py.

define_problem.DefineProblem.krome_dir

Definition at line 27 of file define_problem.without_userdef_constants.py.

define_problem.DefineProblem.kromeoptstr

Definition at line 544 of file define_problem.without_userdef_constants.py.

tuple define_problem.DefineProblem.longword = max(len(w) for w in tmplist1)

static

Definition at line 412 of file define_problem.py.

define_problem.DefineProblem.mod_default

Definition at line 585 of file define_problem.py.

define_problem.DefineProblem.mod_entries

Definition at line 584 of file define_problem.py.

define_problem.DefineProblem.non_usfr

Definition at line 389 of file define_problem.without_userdef_constants.py.

define_problem.DefineProblem.options

Definition at line 138 of file define_problem.py.

define_problem.DefineProblem.options_HD

Definition at line 230 of file define_problem.py.

define_problem.DefineProblem.options_KROME

Definition at line 285 of file define_problem.without_userdef_constants.py.

define_problem.DefineProblem.options_MHD

Definition at line 263 of file define_problem.py.

define_problem.DefineProblem.options_RHD

Definition at line 251 of file define_problem.py.

define_problem.DefineProblem.options_RMHD

Definition at line 296 of file define_problem.py.

tuple define_problem.DefineProblem.pf = pfIO.PlutoFiles(self.work_dir+'/definitions.h')

static

Definition at line 104 of file define_problem.py.

define_problem.DefineProblem.phymodule

Definition at line 490 of file define_problem.py.

define_problem.DefineProblem.pluto_dir

Definition at line 26 of file define_problem.py.

define_problem.DefineProblem.pluto_path

Definition at line 32 of file define_problem.py.

list define_problem.DefineProblem.tmplist1 = tmplist1+['CHAR_LIMITING', 'LIMITER']

static

Definition at line 388 of file define_problem.py.

list define_problem.DefineProblem.tmplist2 = tmplist2+['NO', 'DEFAULT']

static

Definition at line 389 of file define_problem.py.

define_problem.DefineProblem.udef_params

Definition at line 309 of file define_problem.py.

define_problem.DefineProblem.work_dir

Definition at line 25 of file define_problem.py.

The documentation for this class was generated from the following files:

Tools/Python/define_problem.py
Tools/Python/define_problem.without_userdef_constants.py

define_problem
DefineProblem
Generated by 1.8.10

Public Attributes
	work_dir

	pluto_dir

	auto_update

	def_fname

	additional_files

	header_files

	additional_flags

	pluto_path

	def_file_list

	entries

	default

	options

	entries_HD

	default_HD

	options_HD

	entries_RHD

	default_RHD

	options_RHD

	entries_MHD

	default_MHD

	options_MHD

	entries_RMHD

	default_RMHD

	options_RMHD

	udef_params

	phymodule

	mod_entries

	mod_default

	krome_dir

	entries_KROME

	default_KROME

	options_KROME

	non_usfr

	kromeoptstr

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation