SessionReader.cpp 88 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
///////////////////////////////////////////////////////////////////////////////
//
// File SessionReader.cpp
//
// For more information, please see: http://www.nektar.info
//
// The MIT License
//
// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
// Department of Aeronautics, Imperial College London (UK), and Scientific
// Computing and Imaging Institute, University of Utah (USA).
//
// License for the specific language governing rights and limitations under
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// Description: Session reader
//
///////////////////////////////////////////////////////////////////////////////

#ifndef TIXML_USE_STL
#define TIXML_USE_STL
#endif

40 41
#include <LibUtilities/BasicUtils/SessionReader.h>

42
#include <iostream>
43
#include <fstream>
44 45 46
#include <string>
using namespace std;

47 48 49
#include <boost/iostreams/filtering_streambuf.hpp>
#include <boost/iostreams/copy.hpp>
#include <boost/iostreams/filter/gzip.hpp>
50
#include <boost/algorithm/string.hpp>
51
#include <tinyxml.h>
52
#include <LibUtilities/BasicUtils/ErrorUtil.hpp>
53 54
#include <LibUtilities/BasicUtils/Equation.h>
#include <LibUtilities/Memory/NekMemoryManager.hpp>
55
#include <LibUtilities/BasicUtils/MeshPartition.h>
56
#include <LibUtilities/BasicUtils/ParseUtils.hpp>
57
#include <LibUtilities/BasicUtils/FileSystem.h>
58

59
#include <boost/program_options.hpp>
60
#include <boost/format.hpp>
61

62
namespace po = boost::program_options;
63
namespace io = boost::iostreams;
64

65 66 67 68
namespace Nektar
{
    namespace LibUtilities
    {
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
        /**
         * @class SessionReader
         *
         * This class provides an interface to Nektar++-specific content in a
         * supplied XML document. It also initialises a Nektar++ session
         * including setting up communication for parallel execution and where
         * necessary partitioning the supplied mesh for running across multiple
         * processes.
         *
         * A session should be initialised at the beginning of a user's
         * application by passing the command-line arguments. This not only
         * allows the SessionReader to extract the name of the XML document to
         * load containing Nektar++ session information, but also supplies the
         * MPI arguments necessary for setting up parallel communication. The
         * SessionReader should be initialised using the #CreateInstance
         * function:
         * @code
         * LibUtilities::SessionReaderSharedPtr vSession
         *          = LibUtilities::SessionReader::CreateInstance(argc, argv);
         * @endcode
         * The instance \c vSession can now be passed to other key Nektar++
         * components during their construction.
         * @note At the end of the user application, it is important to call the
         * #Finalise routine in order to finalise any MPI communication and
         * correctly free resources.
         *
         * The SessionReader class provides streamlined, validated access to
         * session parameters, solver information and functions defined within a
         * Nektar++ XML document. The available routines and their usage is
         * documented below.
         *
         * In the case of solver information properties, the classes to which
         * these parameters are pertinent may register with the SessionReader
         * class the set of valid values for a given property. Such values may
         * also be associated with an enumeration value for more transparent use
         * of the property values in code.
         */

107 108 109 110 111 112 113 114 115 116 117 118 119
        /**
         * This map of maps stores the list of valid string values for a number
         * of solver information parameters. The top level map connects
         * different parameter names to their list of possible values. The list
         * of possible values is also a map, mapping a valid string to a
         * corresponding enum value.
         *
         * This list is populated through the #RegisterEnumValue static member
         * function which is called statically from various classes to register
         * the valid values for solver info parameters associated with them. The
         * map is therefore fully populated before the SessionReader class is
         * instantiated and a file is read in and parsed.
         */
120 121 122 123 124
        EnumMapList& SessionReader::GetSolverInfoEnums()
        {
            static EnumMapList solverInfoEnums;
            return solverInfoEnums;
        }
125 126 127 128 129 130 131 132 133 134


        /**
         * List of default values for solver information parameters to be used
         * in the case of them not being provided.
         *
         * This list is populated through the #RegisterDefaultSolverInfo static
         * member variable which is called statically from various classes to
         * register the default value for a given parameter.
         */
135 136 137 138 139
        SolverInfoMap& SessionReader::GetSolverInfoDefaults()
        {
            static SolverInfoMap solverInfoMap;
            return solverInfoMap;
        }
140 141


142 143 144 145 146 147 148 149 150
        /**
         * List of values for GlobalSysSoln parameters to be used to override
         * details given in SolverInfo
         *
         * This list is populated by ReadGlobalSysSoln if the
         * GLOBALSYSSOLNINFO section is defined in the input file.
         * This List allows for details to define for the Global Sys
         * solver for each variable. 
         */
151 152 153 154 155
        GloSysSolnInfoList& SessionReader::GetGloSysSolnList()
        {
            static GloSysSolnInfoList gloSysSolnInfoList;
            return gloSysSolnInfoList;
        }
156

157 158 159 160 161 162 163 164
        /**
         * Lists the possible command-line argument which can be specified for
         * this executable.
         *
         * This list is populated through the #RegisterCmdLineArgument static
         * member function which is called statically from various classes to
         * register command-line arguments they need.
         */
165 166 167 168 169
        CmdLineArgMap& SessionReader::GetCmdLineArgMap()
        {
            static CmdLineArgMap cmdLineArguments;
            return cmdLineArguments;
        }
170 171


172 173 174 175 176 177 178 179
        /**
         * This constructor parses the command-line arguments given to the user
         * application to set up any MPI communication, read supplied XML
         * session files, and partition meshes where necessary.
         *
         * @param   argc        Number of command-line arguments
         * @param   argv        Array of command-line arguments
         */
180 181
        SessionReader::SessionReader(int argc, char *argv[])
        {
Chris Cantwell's avatar
Chris Cantwell committed
182
            m_xmlDoc    = 0;
183
            m_filenames = ParseCommandLineArguments(argc, argv);
184

185
            ASSERTL0(m_filenames.size() > 0, "No session file(s) given.");
186

187
            m_filename    = m_filenames[0];
188
            m_sessionName = m_filename.substr(0, m_filename.find_last_of('.'));
189 190 191 192 193 194
            if (m_filename.size() > 3 &&
                m_filename.substr(m_filename.size() - 3, 3) == ".gz")
            {
                m_sessionName =
                    m_sessionName.substr(0, m_sessionName.find_last_of('.'));
            }
195

196
            // Create communicator
197
            CreateComm(argc, argv);
198 199 200 201 202

            // If running in parallel change the default global sys solution
            // type.
            if (m_comm->GetSize() > 1)
            {
203
                GetSolverInfoDefaults()["GLOBALSYSSOLN"] = 
204 205
                    "IterativeStaticCond";
            }
206 207 208
        }


209 210 211
        /**
         *
         */
212 213 214 215 216
        SessionReader::SessionReader(
            int                             argc, 
            char                           *argv[], 
            const std::vector<std::string> &pFilenames, 
            const CommSharedPtr            &pComm)
217 218 219
        {
            ASSERTL0(pFilenames.size() > 0, "No filenames specified.");

220
            ParseCommandLineArguments(argc, argv);
Chris Cantwell's avatar
Chris Cantwell committed
221
            m_xmlDoc      = 0;
222
            m_filenames   = pFilenames;
223

224
            m_filename    = pFilenames[0];
225
            m_sessionName = m_filename.substr(0, m_filename.find_last_of('.'));
226 227 228 229 230 231
            if (m_filename.size() > 3 &&
                m_filename.substr(m_filename.size() - 3, 3) == ".gz")
            {
                m_sessionName =
                    m_sessionName.substr(0, m_sessionName.find_last_of('.'));
            }
232

233
            // Create communicator
234 235
            if (!pComm.get())
            {
236
                CreateComm(argc, argv);
237 238 239 240
            }
            else
            {
                m_comm = pComm;
241 242 243

                if (m_comm->GetSize() > 1)
                {
244
                    GetSolverInfoDefaults()["GLOBALSYSSOLN"] = 
245 246
                        "IterativeStaticCond";
                }
247
            }
248 249 250 251 252

            // If running in parallel change the default global sys solution
            // type.
            if (m_comm->GetSize() > 1)
            {
253
                GetSolverInfoDefaults()["GLOBALSYSSOLN"] = 
254 255
                    "IterativeStaticCond";
            }
256 257 258
        }


259 260 261
        /**
         *
         */
262 263
        SessionReader::~SessionReader()
        {
264
            delete m_xmlDoc;
265 266
        }

267 268 269 270 271 272 273

        /**
         * Performs the main initialisation of the object. The XML file provided
         * on the command-line is loaded and any mesh partitioning is done. The
         * resulting process-specific XML file (containing the process's
         * geometry partition) is then reloaded and parsed.
         */
274 275
        void SessionReader::InitSession()
        {
276 277
            m_exprEvaluator.SetRandomSeed((m_comm->GetRank() + 1) * time(NULL));

278 279 280
            // Split up the communicator
            PartitionComm();

281 282 283
            // Partition mesh
            PartitionMesh();

284 285
            // Parse the XML data in #m_xmlDoc
            ParseDocument();
286 287 288 289

            // Override SOLVERINFO and parameters with any specified on the
            // command line.
            CmdLineOverride();
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315

            // In verbose mode, print out parameters and solver info sections
            if (m_verbose && m_comm)
            {
                if (m_comm->GetRank() == 0 && m_parameters.size() > 0)
                {
                    cout << "Parameters:" << endl;
                    ParameterMap::iterator x;
                    for (x = m_parameters.begin(); x != m_parameters.end(); ++x)
                    {
                        cout << "\t" << x->first << " = " << x->second << endl;
                    }
                    cout << endl;
                }

                if (m_comm->GetRank() == 0 && m_solverInfo.size() > 0)
                {
                    cout << "Solver Info:" << endl;
                    SolverInfoMap::iterator x;
                    for (x = m_solverInfo.begin(); x != m_solverInfo.end(); ++x)
                    {
                        cout << "\t" << x->first << " = " << x->second << endl;
                    }
                    cout << endl;
                }
            }
316 317
        }

318

319
        /**
320 321
         * @brief Parses the command-line arguments for known options and
         * filenames.
322
         */
323 324
        std::vector<std::string> SessionReader::ParseCommandLineArguments(
            int argc, char *argv[])
325 326 327 328
        {
            // List the publically visible options (listed using --help)
            po::options_description desc("Allowed options");
            desc.add_options()
329 330 331 332 333 334
                ("verbose,v",    "be verbose")
                ("help,h",       "print this help message")
                ("solverinfo,I", po::value<vector<std::string> >(), 
                                 "override a SOLVERINFO property")
                ("parameter,P",  po::value<vector<std::string> >(),
                                 "override a parameter")
335
                ("shared-filesystem,s", "Using shared filesystem.")
336 337 338 339 340 341
                ("npx",          po::value<int>(),
                                 "number of procs in X-dir")
                ("npy",          po::value<int>(),
                                 "number of procs in Y-dir")
                ("npz",          po::value<int>(),
                                 "number of procs in Z-dir")
342
                ("part-info",    "Output partition information")
343
            ;
344
            
345
            CmdLineArgMap::const_iterator cmdIt;
346 347
            for (cmdIt  = GetCmdLineArgMap().begin();
                 cmdIt != GetCmdLineArgMap().end(); ++cmdIt)
348 349 350 351 352 353
            {
                std::string names = cmdIt->first;
                if (cmdIt->second.shortName != "")
                {
                    names += "," + cmdIt->second.shortName;
                }
354 355 356 357 358 359 360 361 362 363 364 365 366
                if (cmdIt->second.isFlag)
                {
                    desc.add_options()
                        (names.c_str(), cmdIt->second.description.c_str())
                    ;
                }
                else
                {
                    desc.add_options()
                        (names.c_str(), po::value<std::string>(),
                         cmdIt->second.description.c_str())
                    ;
                }
367
            }
368 369 370 371 372

            // List hidden options (e.g. session file arguments are not actually
            // specified using the input-file option by the user).
            po::options_description hidden("Hidden options");
            hidden.add_options()
373 374
                    ("input-file", po::value< vector<string> >(), 
                                   "input filename")
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
            ;

            // Combine all options for the parser
            po::options_description all("All options");
            all.add(desc).add(hidden);

            // Session file is a positional option
            po::positional_options_description p;
            p.add("input-file", -1);

            // Parse the command-line options
            po::parsed_options parsed = po::command_line_parser(argc, argv).
                                                options(all).
                                                positional(p).
                                                allow_unregistered().
                                                run();

            // Extract known options to map and update
            po::store(parsed, m_cmdLineOptions);
            po::notify(m_cmdLineOptions);

            // Help message
            if (m_cmdLineOptions.count("help"))
            {
                cout << desc << endl;
                exit(0);
            }

            // Enable verbose mode
            if (m_cmdLineOptions.count("verbose"))
            {
                m_verbose = true;
            }
            else
            {
                m_verbose = false;
            }
412
            
413 414 415 416 417 418
            // Print a warning for unknown options
            std::vector< po::basic_option<char> >::iterator x;
            for (x = parsed.options.begin(); x != parsed.options.end(); ++x)
            {
                if (x->unregistered)
                {
419 420
                    cout << "Warning: Unknown option: " << x->string_key 
                         << endl;
421 422 423 424 425 426
                }
            }

            // Return the vector of filename(s) given as positional options
            if (m_cmdLineOptions.count("input-file"))
            {
427 428
                return m_cmdLineOptions["input-file"].as<
                    std::vector<std::string> >();
429 430 431 432 433 434 435 436
            }
            else
            {
                return std::vector<std::string>();
            }
        }


437 438 439
        /**
         *
         */
440 441
        TiXmlDocument& SessionReader::GetDocument()
        {
442
            ASSERTL1(m_xmlDoc, "XML Document not defined.");
443 444 445
            return *m_xmlDoc;
        }

446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465

        /**
         * The single parameter specifies a path to the requested element in a
         * similar format to the filesystem path. Given the following XML:
         * @code
         * <NEKTAR>
         *   <CONDITIONS>
         *     <PARAMETERS>
         *     ...
         *     </PARAMETERS>
         *   </CONDITIONS>
         * </NEKTAR>
         * @endcode
         * the PARAMETERS element would be retrieved by requesting the path:
         * @code
         * Nektar/Conditions/Parameters
         * @endcode
         * @note Paths are case-insensitive.
         *
         * @param   pPath       Path to requested element.
466 467
         *
         * @return Direct pointer to requested XML Element.
468
         */
469 470 471
        TiXmlElement* SessionReader::GetElement(const string& pPath)
        {
            std::string vPath = boost::to_upper_copy(pPath);
472 473 474
            std::vector<std::string> st;
            boost::split(st, vPath, boost::is_any_of("\\/ "));
            ASSERTL0(st.size() > 0, "No path given in XML element request.");
475

476
            TiXmlElement* vReturn = m_xmlDoc->FirstChildElement(st[0].c_str());
477
            ASSERTL0(vReturn, std::string("Cannot find element '")
478 479
                              + st[0] + std::string("'."));
            for (int i = 1; i < st.size(); ++i)
480
            {
481
                vReturn = vReturn->FirstChildElement(st[i].c_str());
482
                ASSERTL0(vReturn, std::string("Cannot find element '")
483
                                  + st[i] + std::string("'."));
484 485 486 487
            }
            return vReturn;
        }

488 489 490 491 492

        /**
         *
         */
        bool SessionReader::DefinesElement(const std::string &pPath) const
493 494
        {
            std::string vPath = boost::to_upper_copy(pPath);
495 496 497
            std::vector<std::string> st;
            boost::split(st, vPath, boost::is_any_of("\\/ "));
            ASSERTL0(st.size() > 0, "No path given in XML element request.");
498

499
            TiXmlElement* vReturn = m_xmlDoc->FirstChildElement(st[0].c_str());
500
            ASSERTL0(vReturn, std::string("Cannot find element '")
501 502
                              + st[0] + std::string("'."));
            for (int i = 1; i < st.size(); ++i)
503
            {
504
                vReturn = vReturn->FirstChildElement(st[i].c_str());
505 506 507 508 509
                if (!vReturn) return false;
            }
            return true;
        }

510 511 512 513

        /**
         *
         */
514
        const std::string& SessionReader::GetFilename() const
515 516 517 518
        {
            return m_filename;
        }

519 520 521 522

        /**
         *
         */
523 524 525 526 527
        const std::string& SessionReader::GetSessionName() const
        {
            return m_sessionName;
        }

528

529 530 531 532 533 534
        /**
         * Output is of the form [sessionName]_P[idx] where idx is the rank
         * of the process.
         */
        const std::string SessionReader::GetSessionNameRank() const
        {
535
            std::string  dirname = m_sessionName + "_xml"; 
536 537
            fs::path     pdirname(dirname);
            
538
            std::string vFilename = "P" + boost::lexical_cast<std::string>(m_comm->GetRowComm()->GetRank());
539
            fs::path    pFilename(vFilename);            
540

541
            fs::path fullpath = pdirname / pFilename;
542

543 544
            return PortablePath(fullpath);
        }
545

546 547 548
        /**
         *
         */
549 550 551 552 553
        CommSharedPtr& SessionReader::GetComm()
        {
            return m_comm;
        }

554 555 556 557 558 559 560

        /**
         * This routine finalises any parallel communication.
         *
         * @note This routine should be called at the very end of a users
         * application.
         */
561 562 563 564 565
        void SessionReader::Finalise()
        {
            m_comm->Finalise();
        }

566

567 568 569 570 571 572
        /**
         *
         */
        bool SessionReader::DefinesParameter(const std::string& pName) const
        {
            std::string vName = boost::to_upper_copy(pName);
573 574
            ParameterMap::const_iterator paramIter = m_parameters.find(vName);
            return (paramIter != m_parameters.end());
575 576
        }

577 578 579 580 581 582 583 584 585

        /**
         * If the parameter is not defined, termination occurs. Therefore, the
         * parameters existence should be tested for using #DefinesParameter
         * before calling this function.
         *
         * @param   pName       The name of a floating-point parameter.
         * @returns The value of the floating-point parameter.
         */
586 587
        const NekDouble& SessionReader::GetParameter(
            const std::string& pName) const
588 589
        {
            std::string vName = boost::to_upper_copy(pName);
590
            ParameterMap::const_iterator paramIter = m_parameters.find(vName);
591

592 593
            ASSERTL0(paramIter != m_parameters.end(),
                     "Unable to find requested parameter: " + pName);
594

595
            return paramIter->second;
596 597
        }

598 599 600 601

        /**
         *
         */
602 603
        void SessionReader::LoadParameter(
            const std::string &pName, int &pVar) const
604 605
        {
            std::string vName = boost::to_upper_copy(pName);
606 607 608 609
            ParameterMap::const_iterator paramIter = m_parameters.find(vName);
            ASSERTL0(paramIter != m_parameters.end(), "Required parameter '" + 
                     pName + "' not specified in session.");
            pVar = (int)floor(paramIter->second);
610 611
        }

612 613 614 615

        /**
         *
         */
616 617
        void SessionReader::LoadParameter(
            const std::string &pName, int &pVar, const int &pDefault) const
618 619
        {
            std::string vName = boost::to_upper_copy(pName);
620 621
            ParameterMap::const_iterator paramIter = m_parameters.find(vName);
            if(paramIter != m_parameters.end())
622
            {
623
                pVar = (int)floor(paramIter->second);
624 625 626 627 628 629 630
            }
            else
            {
                pVar  = pDefault;
            }
        }

631 632 633 634

        /**
         *
         */
635 636
        void SessionReader::LoadParameter(
            const std::string &pName, NekDouble& pVar) const
637 638
        {
            std::string vName = boost::to_upper_copy(pName);
639 640 641 642
            ParameterMap::const_iterator paramIter = m_parameters.find(vName);
            ASSERTL0(paramIter != m_parameters.end(), "Required parameter '" + 
                     pName + "' not specified in session.");
            pVar = paramIter->second;
643 644
        }

645 646 647 648

        /**
         *
         */
649 650 651 652
        void SessionReader::LoadParameter(
            const std::string &pName, 
                  NekDouble   &pVar, 
            const NekDouble   &pDefault) const
653 654
        {
            std::string vName = boost::to_upper_copy(pName);
655 656
            ParameterMap::const_iterator paramIter = m_parameters.find(vName);
            if(paramIter != m_parameters.end())
657
            {
658
                pVar = paramIter->second;
659 660 661
            }
            else
            {
662
                pVar = pDefault;
663 664 665
            }
        }

666

Spencer Sherwin's avatar
Spencer Sherwin committed
667 668 669 670 671 672 673 674 675 676 677 678 679 680

        /**
         *
         */
        void SessionReader::SetParameter(const std::string &pName, int &pVar) 
        {
            std::string vName = boost::to_upper_copy(pName);
            m_parameters[vName] = pVar;
        }


        /**
         *
         */
681 682
        void SessionReader::SetParameter(
            const std::string &pName, NekDouble& pVar) 
Spencer Sherwin's avatar
Spencer Sherwin committed
683 684 685 686 687 688 689
        {
            std::string vName = boost::to_upper_copy(pName);
            m_parameters[vName] = pVar;
        }



690 691 692 693
        /**
         *
         */
        bool SessionReader::DefinesSolverInfo(const std::string &pName) const
694 695
        {
            std::string vName = boost::to_upper_copy(pName);
696 697
            SolverInfoMap::const_iterator infoIter = m_solverInfo.find(vName);
            return (infoIter != m_solverInfo.end());
698 699
        }

700 701 702 703

        /**
         *
         */
704 705
        const std::string& SessionReader::GetSolverInfo(
            const std::string &pProperty) const
706 707
        {
            std::string vProperty = boost::to_upper_copy(pProperty);
708
            SolverInfoMap::const_iterator iter = m_solverInfo.find(vProperty);
709

710 711
            ASSERTL1(iter != m_solverInfo.end(),
                     "Unable to find requested property: " + pProperty);
712

713
            return iter->second;
714 715
        }

Sergey Yakovlev's avatar
Sergey Yakovlev committed
716 717 718 719 720 721 722 723 724 725 726 727 728 729
        /**
         *
         */
        void SessionReader::SetSolverInfo(
            const std::string &pProperty, const std::string &pValue) 
        {
            std::string vProperty = boost::to_upper_copy(pProperty);
            SolverInfoMap::iterator iter = m_solverInfo.find(vProperty);

            ASSERTL1(iter != m_solverInfo.end(),
                     "Unable to find requested property: " + pProperty);

            iter->second = pValue;
        }
730 731 732 733

        /**
         *
         */
734 735 736 737
        void SessionReader::LoadSolverInfo(
            const std::string &pName, 
                  std::string &pVar, 
            const std::string &pDefault) const
738 739
        {
            std::string vName = boost::to_upper_copy(pName);
740 741
            SolverInfoMap::const_iterator infoIter = m_solverInfo.find(vName);
            if(infoIter != m_solverInfo.end())
742
            {
743
                pVar = infoIter->second;
744 745 746
            }
            else
            {
747
                pVar = pDefault;
748 749 750
            }
        }

751 752 753 754

        /**
         *
         */
755 756 757 758 759
        void SessionReader::MatchSolverInfo(
            const std::string &pName,
            const std::string &pTrueVal,
                  bool        &pVar,
            const bool        &pDefault) const
760 761
        {
            std::string vName = boost::to_upper_copy(pName);
762 763
            SolverInfoMap::const_iterator infoIter = m_solverInfo.find(vName);
            if(infoIter != m_solverInfo.end())
764
            {
765
                pVar = boost::iequals(infoIter->second, pTrueVal);
766 767 768
            }
            else
            {
769
                pVar = pDefault;
770 771 772
            }
        }

773 774 775 776

        /**
         *
         */
777 778 779
        bool SessionReader::MatchSolverInfo(
            const std::string &pName,
            const std::string &pTrueVal) const
780 781 782 783
        {
            if (DefinesSolverInfo(pName))
            {
                std::string vName = boost::to_upper_copy(pName);
784 785
                SolverInfoMap::const_iterator iter = m_solverInfo.find(vName);
                if(iter != m_solverInfo.end())
786 787 788 789 790 791 792 793
                {
                    return true;
                }
            }
            return false;
        }


794 795 796 797 798 799 800
        /**
         *
         */
        bool SessionReader::DefinesGlobalSysSolnInfo(const std::string &pVariable, 
                                                     const std::string &pProperty) const
        {

801 802 803
            GloSysSolnInfoList::const_iterator iter =
                    GetGloSysSolnList().find(pVariable);
            if(iter == GetGloSysSolnList().end())
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826
            {
                return false;
            }

            std::string vProperty = boost::to_upper_copy(pProperty);
            
            GloSysInfoMap::const_iterator iter1 = iter->second.find(vProperty);
            if(iter1 == iter->second.end())
            {
                return false;
            }
            
            return true;
        }

        
        /**
         *
         */
        const std::string &SessionReader::GetGlobalSysSolnInfo(const std::string &pVariable, const std::string &pProperty) const
        {
            GloSysSolnInfoList::const_iterator iter; 

827 828
            ASSERTL0( (iter = GetGloSysSolnList().find(pVariable)) !=
                              GetGloSysSolnList().end(),
829 830 831 832 833 834 835 836 837 838 839
                      "Failed to find variable in GlobalSysSolnInfoList");

            std::string vProperty = boost::to_upper_copy(pProperty);
            GloSysInfoMap::const_iterator iter1; 

            ASSERTL0( (iter1 = iter->second.find(vProperty)) != iter->second.end(),
                      "Failed to find property: " + vProperty + " in GlobalSysSolnInfoList");
            
            return iter1->second;
        }
        
840 841 842 843
        /**
         *
         */
        bool SessionReader::DefinesGeometricInfo(const std::string &pName) const
844 845
        {
            std::string vName = boost::to_upper_copy(pName);
846 847
            GeometricInfoMap::const_iterator iter = m_geometricInfo.find(vName);
            return (iter != m_geometricInfo.end());
848 849
        }

850 851 852 853

        /**
         *
         */
854 855 856 857
        void SessionReader::LoadGeometricInfo(
            const std::string &pName,
                  std::string &pVar,
            const std::string &pDefault) const
858 859
        {
            std::string vName = boost::to_upper_copy(pName);
860 861
            GeometricInfoMap::const_iterator iter = m_geometricInfo.find(vName);
            if(iter != m_geometricInfo.end())
862
            {
863
                pVar = iter->second;
864 865 866
            }
            else
            {
867
                pVar = pDefault;
868 869 870
            }
        }

871 872 873 874

        /**
         *
         */
875 876 877 878
        void SessionReader::LoadGeometricInfo(
            const std::string &pName,
                  bool        &pVar,
            const bool        &pDefault) const
879 880
        {
            std::string vName = boost::to_upper_copy(pName);
881 882
            GeometricInfoMap::const_iterator iter = m_geometricInfo.find(vName);
            if(iter != m_geometricInfo.end())
883
            {
884
                if (iter->second == "TRUE")
885 886 887 888 889 890 891 892 893 894
                {
                    pVar = true;
                }
                else
                {
                    pVar = false;
                }
            }
            else
            {
895
                pVar = pDefault;
896 897 898
            }
        }

899

900 901 902
        /**
         *
         */
903 904 905 906
        void SessionReader::LoadGeometricInfo(
            const std::string &pName,
                  NekDouble   &pVar,
            const NekDouble   &pDefault) const
907 908
        {
            std::string vName = boost::to_upper_copy(pName);
909 910
            GeometricInfoMap::const_iterator iter = m_geometricInfo.find(vName);
            if(iter != m_geometricInfo.end())
911
            {
912
                pVar = std::atoi(iter->second.c_str());
913 914 915
            }
            else
            {
916
                pVar = pDefault;
917 918 919 920
            }
        }


921 922 923
        /**
         *
         */
924 925 926 927 928
        void SessionReader::MatchGeometricInfo(
            const std::string &pName,
            const std::string &pTrueVal,
                  bool        &pVar,
            const bool        &pDefault) const
929 930
        {
            std::string vName = boost::to_upper_copy(pName);
931 932
            GeometricInfoMap::const_iterator iter = m_geometricInfo.find(vName);
            if(iter != m_geometricInfo.end())
933
            {
934
                pVar = boost::iequals(iter->second, pTrueVal);
935 936 937 938 939 940 941 942
            }
            else
            {
                pVar  = pDefault;
            }
        }


943 944 945
        /**
         *
         */
946 947
        const std::string& SessionReader::GetVariable(
            const unsigned int &idx) const
948 949 950 951 952
        {
            ASSERTL0(idx < m_variables.size(), "Variable index out of range.");
            return m_variables[idx];
        }

953

954 955 956 957 958 959 960 961 962 963 964 965

        /**
         *
         */
        void SessionReader::SetVariable(const unsigned int &idx, 
                                        std::string newname) 
        {
            ASSERTL0(idx < m_variables.size(), "Variable index out of range.");
            m_variables[idx] = newname;
        }


966 967 968
        /**
         *
         */
969 970 971 972 973
        std::vector<std::string> SessionReader::GetVariables() const
        {
            return m_variables;
        }

974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993

        /**
         *
         */
        bool SessionReader::DefinesFunction(const std::string &pName) const
        {
            FunctionMap::const_iterator it1;
            std::string vName = boost::to_upper_copy(pName);

            if ((it1 = m_functions.find(vName)) != m_functions.end())
            {
                return true;
            }
            return false;
        }


        /**
         *
         */
994 995
        bool SessionReader::DefinesFunction(
            const std::string &pName,
996 997
            const std::string &pVariable,
            const int pDomain) const
998 999
        {
            FunctionMap::const_iterator it1;
1000
            FunctionVariableMap::const_iterator it2;
1001 1002
            std::string vName = boost::to_upper_copy(pName);

1003 1004
            // Check function exists
            if ((it1 = m_functions.find(vName))     != m_functions.end())
1005
            {
1006 1007
                pair<std::string, int> key(pVariable,pDomain);
                pair<std::string, int> defkey("*",pDomain);
1008
                bool varExists =
1009 1010
                    (it2 = it1->second.find(key)) != it1->second.end() ||
                    (it2 = it1->second.find(defkey)) != it1->second.end();
1011
                return varExists;
1012 1013 1014 1015 1016 1017 1018 1019
            }
            return false;
        }


        /**
         *
         */
1020 1021
        EquationSharedPtr SessionReader::GetFunction(
            const std::string &pName,
1022 1023
            const std::string &pVariable,
            const int pDomain) const
1024 1025
        {
            FunctionMap::const_iterator it1;
1026
            FunctionVariableMap::const_iterator it2, it3;
1027 1028 1029 1030 1031
            std::string vName = boost::to_upper_copy(pName);

            ASSERTL0((it1 = m_functions.find(vName)) != m_functions.end(),
                     std::string("No such function '") + pName
                     + std::string("' has been defined in the session file."));
1032 1033

            // Check for specific and wildcard definitions
1034 1035 1036 1037 1038 1039
            pair<std::string,int> key(pVariable,pDomain);
            pair<std::string,int> defkey("*",pDomain);
            bool specific = (it2 = it1->second.find(key)) !=
                it1->second.end();
            bool wildcard = (it3 = it1->second.find(defkey)) !=
                it1->second.end();
1040 1041 1042

            // Check function is defined somewhere
            ASSERTL0(specific || wildcard,
1043 1044 1045 1046
                     "No such variable " + pVariable
                     + " in domain " + boost::lexical_cast<string>(pDomain) 
                     + " defined for function " + pName
                     + " in session file.");
1047 1048 1049 1050 1051 1052 1053

            // If not specific, must be wildcard
            if (!specific)
            {
                it2 = it3;
            }

1054
            ASSERTL0((it2->second.m_type == eFunctionTypeExpression),
1055
                    std::string("Function is defined by a file."));
1056
            return it2->second.m_expression;
1057 1058
        }

1059 1060 1061 1062

        /**
         *
         */
1063 1064
        EquationSharedPtr SessionReader::GetFunction(
            const std::string  &pName,
1065 1066
            const unsigned int &pVar,
            const int pDomain) const
1067 1068
        {
            ASSERTL0(pVar < m_variables.size(), "Variable index out of range.");
1069
            return GetFunction(pName, m_variables[pVar],pDomain);
1070 1071
        }

1072 1073 1074 1075

        /**
         *
         */
1076 1077
        enum FunctionType SessionReader::GetFunctionType(
            const std::string &pName,
1078 1079
            const std::string &pVariable,
            const int pDomain) const
1080 1081
        {
            FunctionMap::const_iterator it1;
1082
            FunctionVariableMap::const_iterator it2, it3;
1083 1084 1085 1086 1087 1088
            std::string vName = boost::to_upper_copy(pName);

            it1 = m_functions.find(vName);
            ASSERTL0 (it1 != m_functions.end(),
                      std::string("Function '") + pName
                      + std::string("' not found."));
1089 1090

            // Check for specific and wildcard definitions
1091 1092 1093
            pair<std::string,int> key(pVariable,pDomain);
            pair<std::string,int> defkey("*",pDomain);
            bool specific = (it2 = it1->second.find(key)) !=
1094
                            it1->second.end();
1095
            bool wildcard = (it3 = it1->second.find(defkey)) !=
1096 1097 1098 1099
                            it1->second.end();

            // Check function is defined somewhere
            ASSERTL0(specific || wildcard,
1100 1101 1102 1103
                     "No such variable " + pVariable
                     + " in domain " + boost::lexical_cast<string>(pDomain) 
                     + " defined for function " + pName
                     + " in session file.");
1104 1105 1106 1107 1108 1109 1110

            // If not specific, must be wildcard
            if (!specific)
            {
                it2 = it3;
            }

1111
            return it2->second.m_type;
1112 1113
        }

1114 1115 1116 1117

        /**
         *
         */
1118 1119
        enum FunctionType SessionReader::GetFunctionType(
            const std::string  &pName,
1120 1121
            const unsigned int &pVar,
            const int pDomain) const
1122 1123
        {
            ASSERTL0(pVar < m_variables.size(), "Variable index out of range.");
1124
            return GetFunctionType(pName, m_variables[pVar],pDomain);
1125 1126 1127 1128 1129 1130
        }


        /**
         *
         */
1131 1132
        std::string SessionReader::GetFunctionFilename(
            const std::string &pName, 
1133 1134
            const std::string &pVariable,
            const int pDomain) const
1135 1136
        {
            FunctionMap::const_iterator it1;
1137
            FunctionVariableMap::const_iterator it2, it3;
1138 1139 1140 1141 1142 1143
            std::string vName = boost::to_upper_copy(pName);

            it1 = m_functions.find(vName);
            ASSERTL0 (it1 != m_functions.end(),
                      std::string("Function '") + pName
                      + std::string("' not found."));
1144 1145

            // Check for specific and wildcard definitions
1146 1147 1148
            pair<std::string,int> key(pVariable,pDomain);
            pair<std::string,int> defkey("*",pDomain);
            bool specific = (it2 = it1->second.find(key)) !=
1149
                            it1->second.end();
1150
            bool wildcard = (it3 = it1->second.find(defkey)) !=
1151 1152 1153 1154
                            it1->second.end();

            // Check function is defined somewhere
            ASSERTL0(specific || wildcard,
1155 1156 1157 1158 1159
                     "No such variable " + pVariable
                     + " in domain " + boost::lexical_cast<string>(pDomain) 
                     + " defined for function " + pName
                     + " in session file.");
            
1160 1161 1162 1163 1164 1165
            // If not specific, must be wildcard
            if (!specific)
            {
                it2 = it3;
            }

1166 1167 1168 1169 1170 1171 1172
            return it2->second.m_filename;
        }


        /**
         *
         */
1173 1174
        std::string SessionReader::GetFunctionFilename(
            const std::string  &pName, 
1175 1176
            const unsigned int &pVar,
            const int pDomain) const
1177 1178
        {
            ASSERTL0(pVar < m_variables.size(), "Variable index out of range.");
1179
            return GetFunctionFilename(pName, m_variables[pVar],pDomain);
1180 1181 1182
        }


1183 1184 1185 1186 1187 1188 1189 1190 1191
        /**
         *
         */
        AnalyticExpressionEvaluator& SessionReader::GetExpressionEvaluator()
        {
            return m_exprEvaluator;
        }


1192 1193 1194 1195
        /**
         *
         */
        bool SessionReader::DefinesTag(const std::string &pName) const
1196 1197
        {
            std::string vName = boost::to_upper_copy(pName);
1198
            TagMap::const_iterator vTagIterator = m_tags.find(vName);
1199 1200 1201
            return (vTagIterator != m_tags.end());
        }

1202 1203 1204 1205

        /**
         *
         */
1206 1207 1208
        void SessionReader::SetTag(
            const std::string &pName, 
            const std::string &pValue)
1209 1210 1211 1212 1213
        {
            std::string vName = boost::to_upper_copy(pName);
            m_tags[vName] = pValue;
        }

1214 1215 1216 1217 1218

        /**
         *
         */
        const std::string &SessionReader::GetTag(const std::string& pName) const
1219 1220
        {
            std::string vName = boost::to_upper_copy(pName);
1221
            TagMap::const_iterator vTagIterator = m_tags.find(vName);
1222 1223 1224 1225 1226
            ASSERTL0(vTagIterator != m_tags.end(),
                     "Requested tag does not exist.");
            return vTagIterator->second;
        }

1227

1228 1229 1230 1231 1232 1233 1234 1235 1236
        /**
         *
         */
        const FilterMap &SessionReader::GetFilters() const
        {
            return m_filters;
        }


1237 1238 1239
        /**
         *
         */
1240 1241
        bool SessionReader::DefinesCmdLineArgument(
            const std::string& pName) const
1242 1243 1244 1245 1246
        {
            return (m_cmdLineOptions.find(pName) != m_cmdLineOptions.end());
        }


1247 1248 1249 1250 1251 1252
        /**
         *
         */
        void SessionReader::SubstituteExpressions(std::string& pExpr)
        {
            ExpressionMap::iterator exprIter;
1253 1254
            for (exprIter  = m_expressions.begin(); 
                 exprIter != m_expressions.end(); ++exprIter)
1255 1256 1257 1258 1259
            {
                boost::replace_all(pExpr, exprIter->first, exprIter->second);
            }
        }

1260 1261 1262 1263
        CompositeOrdering SessionReader::GetCompositeOrdering() const
        {
            return m_compOrder;
        }
1264

1265 1266 1267 1268 1269
        BndRegionOrdering SessionReader::GetBndRegionOrdering() const
        {
            return m_bndRegOrder;
        }

1270 1271 1272 1273 1274 1275 1276
        /**
         *
         */
        void SessionReader::LoadDoc(
            const std::string &pFilename,
            TiXmlDocument* pDoc) const
        {
1277 1278
            if (pFilename.size() > 3 &&
                pFilename.substr(pFilename.size() - 3, 3) == ".gz")
1279
            {
1280 1281 1282
                ifstream file(pFilename.c_str(),
                              ios_base::in | ios_base::binary);
                ASSERTL0(file.good(), "Unable to open file: " + pFilename);
1283
                stringstream ss;
1284 1285
                io::filtering_streambuf<io::input> in;
                in.push(io::gzip_decompressor());
1286
                in.push(file);
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
                try
                {
                    io::copy(in, ss);
                    ss >> (*pDoc);
                }
                catch (io::gzip_error& e)
                {
                    ASSERTL0(false,
                             "Error: File '" + pFilename + "' is corrupt.");
                }
1297 1298 1299
            }
            else
            {
1300 1301 1302
                ifstream file(pFilename.c_str());
                ASSERTL0(file.good(), "Unable to open file: " + pFilename);
                file >> (*pDoc);
1303 1304 1305
            }
        }

1306 1307 1308
        /**
         *
         */
1309 1310
        TiXmlDocument *SessionReader::MergeDoc(
            const std::vector<std::string> &pFilenames) const
1311
        {