SessionReader.cpp 92.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
///////////////////////////////////////////////////////////////////////////////
//
// 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
Dave Moxey's avatar
Dave Moxey committed
22
// in all copies or substantial portions of the Software.
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
//
// 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
#include <LibUtilities/BasicUtils/SessionReader.h>
41
#include <LibUtilities/BasicConst/GitRevision.h>
42

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

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

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

63 64 65 66
#ifndef NEKTAR_VERSION
#define NEKTAR_VERSION "Unknown"
#endif

67
namespace po = boost::program_options;
68
namespace io = boost::iostreams;
69

70 71 72 73
namespace Nektar
{
    namespace LibUtilities
    {
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 107 108 109 110 111
        /**
         * @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.
         */

112 113 114 115 116 117 118 119 120 121 122 123 124
        /**
         * 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.
         */
125 126 127 128 129
        EnumMapList& SessionReader::GetSolverInfoEnums()
        {
            static EnumMapList solverInfoEnums;
            return solverInfoEnums;
        }
130 131 132 133 134 135 136 137 138 139


        /**
         * 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.
         */
140 141 142 143 144
        SolverInfoMap& SessionReader::GetSolverInfoDefaults()
        {
            static SolverInfoMap solverInfoMap;
            return solverInfoMap;
        }
145 146


147 148 149 150 151 152 153
        /**
         * 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
154
         * solver for each variable.
155
         */
156 157 158 159 160
        GloSysSolnInfoList& SessionReader::GetGloSysSolnList()
        {
            static GloSysSolnInfoList gloSysSolnInfoList;
            return gloSysSolnInfoList;
        }
161

162 163 164 165 166 167 168 169
        /**
         * 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.
         */
170 171 172 173 174
        CmdLineArgMap& SessionReader::GetCmdLineArgMap()
        {
            static CmdLineArgMap cmdLineArguments;
            return cmdLineArguments;
        }
175 176


177 178 179 180 181 182 183 184
        /**
         * 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
         */
185 186
        SessionReader::SessionReader(int argc, char *argv[])
        {
Chris Cantwell's avatar
Chris Cantwell committed
187
            m_xmlDoc    = 0;
188
            m_filenames = ParseCommandLineArguments(argc, argv);
189

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

192
            m_sessionName = ParseSessionName(m_filenames);
193

194
            // Create communicator
195
            CreateComm(argc, argv);
196

197 198
            TestSharedFilesystem();

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
        SessionReader::SessionReader(
213 214 215
            int                             argc,
            char                           *argv[],
            const std::vector<std::string> &pFilenames,
216
            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_sessionName = ParseSessionName(m_filenames);
225

226
            // Create communicator
227 228
            if (!pComm.get())
            {
229
                CreateComm(argc, argv);
230 231 232 233
            }
            else
            {
                m_comm = pComm;
234 235 236

                if (m_comm->GetSize() > 1)
                {
237
                    GetSolverInfoDefaults()["GLOBALSYSSOLN"] =
238 239
                        "IterativeStaticCond";
                }
240
            }
241

242 243
            TestSharedFilesystem();

244 245 246 247
            // If running in parallel change the default global sys solution
            // type.
            if (m_comm->GetSize() > 1)
            {
248
                GetSolverInfoDefaults()["GLOBALSYSSOLN"] =
249
                    "IterativeStaticCond";
250
            }
251 252 253
        }


254 255 256
        /**
         *
         */
257 258
        SessionReader::~SessionReader()
        {
259
            delete m_xmlDoc;
260 261
        }

262 263 264 265 266 267 268

        /**
         * 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.
         */
269 270
        void SessionReader::InitSession()
        {
271 272
            m_exprEvaluator.SetRandomSeed((m_comm->GetRank() + 1) * time(NULL));

273 274 275
            // Split up the communicator
            PartitionComm();

276 277 278
            // Partition mesh
            PartitionMesh();

279 280
            // Parse the XML data in #m_xmlDoc
            ParseDocument();
281 282 283 284

            // Override SOLVERINFO and parameters with any specified on the
            // command line.
            CmdLineOverride();
285

286 287 288
            // Verify SOLVERINFO values
            VerifySolverInfo();

289 290 291
            // In verbose mode, print out parameters and solver info sections
            if (m_verbose && m_comm)
            {
292
                if (m_comm->TreatAsRankZero() && m_parameters.size() > 0)
293 294
                {
                    cout << "Parameters:" << endl;
295
                    for (auto &x : m_parameters)
296
                    {
297
                        cout << "\t" << x.first << " = " << x.second << endl;
298 299 300 301
                    }
                    cout << endl;
                }

302
                if (m_comm->TreatAsRankZero() && m_solverInfo.size() > 0)
303 304
                {
                    cout << "Solver Info:" << endl;
305
                    for (auto &x : m_solverInfo)
306
                    {
307
                        cout << "\t" << x.first << " = " << x.second << endl;
308 309 310 311
                    }
                    cout << endl;
                }
            }
312 313
        }

314

315 316 317 318 319 320 321 322
        void SessionReader::TestSharedFilesystem()
        {
            m_sharedFilesystem = false;

            if (m_comm->GetSize() > 1)
            {
                if (m_comm->GetRank() == 0)
                {
Kilian Lackhove's avatar
Kilian Lackhove committed
323
                    std::ofstream testfile("shared-fs-testfile");
324
                    testfile << "" << std::endl;
Kilian Lackhove's avatar
Kilian Lackhove committed
325
                    ASSERTL1(!testfile.fail(), "Test file creation failed");
326 327 328 329
                    testfile.close();
                }
                m_comm->Block();

Kilian Lackhove's avatar
Kilian Lackhove committed
330
                int exists = (bool)boost::filesystem::exists("shared-fs-testfile");
331 332 333 334
                m_comm->AllReduce(exists, LibUtilities::ReduceSum);

                m_sharedFilesystem = (exists == m_comm->GetSize());

Kilian Lackhove's avatar
Kilian Lackhove committed
335 336
                if ((m_sharedFilesystem && m_comm->GetRank() == 0) ||
                    !m_sharedFilesystem)
337 338 339 340 341 342 343 344 345 346 347
                {
                    std::remove("shared-fs-testfile");
                }
            }
            else
            {
                m_sharedFilesystem = false;
            }

            if (m_verbose && m_comm->GetRank() == 0 && m_sharedFilesystem)
            {
Kilian Lackhove's avatar
Kilian Lackhove committed
348
                cout << "Shared filesystem detected" << endl;
349 350 351 352
            }
        }


353
        /**
354 355
         * @brief Parses the command-line arguments for known options and
         * filenames.
356
         */
357 358
        std::vector<std::string> SessionReader::ParseCommandLineArguments(
            int argc, char *argv[])
359 360 361 362
        {
            // List the publically visible options (listed using --help)
            po::options_description desc("Allowed options");
            desc.add_options()
363
                ("verbose,v",    "be verbose")
364
                ("version,V",    "print version information")
365
                ("help,h",       "print this help message")
366
                ("solverinfo,I", po::value<vector<std::string> >(),
367 368 369
                                 "override a SOLVERINFO property")
                ("parameter,P",  po::value<vector<std::string> >(),
                                 "override a parameter")
370 371 372 373 374 375
                ("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")
376
                ("nsz",          po::value<int>(),
377
                                 "number of slices in Z-dir")
378 379
                ("part-only",    po::value<int>(),
                                 "only partition mesh into N partitions.")
380 381
                ("part-only-overlapping",    po::value<int>(),
                                 "only partition mesh into N overlapping partitions.")
382
                ("part-info",    "Output partition information")
383
            ;
384

385
            for (auto &cmdIt : GetCmdLineArgMap())
386
            {
387 388
                std::string names = cmdIt.first;
                if (cmdIt.second.shortName != "")
389
                {
390
                    names += "," + cmdIt.second.shortName;
391
                }
392
                if (cmdIt.second.isFlag)
393 394
                {
                    desc.add_options()
395
                        (names.c_str(), cmdIt.second.description.c_str())
396 397 398 399 400 401
                    ;
                }
                else
                {
                    desc.add_options()
                        (names.c_str(), po::value<std::string>(),
402
                         cmdIt.second.description.c_str())
403 404
                    ;
                }
405
            }
406 407 408 409 410

            // 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()
411
                    ("input-file", po::value< vector<string> >(),
412
                                   "input filename")
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
            ;

            // 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"))
            {
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
                cout << desc;
                exit(0);
            }

            // Version information
            if (m_cmdLineOptions.count("version"))
            {
                cout << "Nektar++ version " << NEKTAR_VERSION;

                if (NekConstants::kGitSha1 != "GITDIR-NOTFOUND")
                {
                    string sha1(NekConstants::kGitSha1);
                    string branch(NekConstants::kGitBranch);
                    boost::replace_all(branch, "refs/heads/", "");

Dave Moxey's avatar
Dave Moxey committed
452 453 454 455 456 457 458 459 460 461 462 463
                    cout << " (git changeset " << sha1.substr(0, 8) << ", ";

                    if (branch == "")
                    {
                        cout << "detached head";
                    }
                    else
                    {
                        cout << "head " << branch;
                    }

                    cout << ")";
464 465 466
                }

                cout << endl;
467 468 469 470 471 472 473 474 475 476 477 478
                exit(0);
            }

            // Enable verbose mode
            if (m_cmdLineOptions.count("verbose"))
            {
                m_verbose = true;
            }
            else
            {
                m_verbose = false;
            }
479

480
            // Print a warning for unknown options
481
            for (auto &x : parsed.options)
482
            {
483
                if (x.unregistered)
484
                {
485
                    cout << "Warning: Unknown option: " << x.string_key
486
                         << endl;
487 488 489 490 491 492
                }
            }

            // Return the vector of filename(s) given as positional options
            if (m_cmdLineOptions.count("input-file"))
            {
493 494
                return m_cmdLineOptions["input-file"].as<
                    std::vector<std::string> >();
495 496 497 498 499 500 501 502
            }
            else
            {
                return std::vector<std::string>();
            }
        }


503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
        /**
         *
         */
        std::string SessionReader::ParseSessionName(
                std::vector<std::string> &filenames)
        {
            ASSERTL0(!filenames.empty(),
                     "At least one filename expected.");

            std::string retval = "";

            // First input file defines the session name
            std::string fname = filenames[0];

            // If loading a pre-partitioned mesh, remove _xml extension
            if (fname.size() > 4 &&
                fname.substr(fname.size() - 4, 4) == "_xml")
            {
                retval = fname.substr(0, fname.find_last_of("_"));
            }
            // otherwise remove the .xml extension
            else if (fname.size() > 4 &&
                fname.substr(fname.size() - 4, 4) == ".xml")
            {
                retval = fname.substr(0, fname.find_last_of("."));
            }
            // If compressed .xml.gz, remove both extensions
            else if (fname.size() > 7 &&
                fname.substr(fname.size() - 7, 7) == ".xml.gz")
            {
                retval = fname.substr(0, fname.find_last_of("."));
                retval = retval.substr(0, retval.find_last_of("."));
            }

            return retval;
        }


541 542 543
        /**
         *
         */
544 545
        TiXmlDocument& SessionReader::GetDocument()
        {
546
            ASSERTL1(m_xmlDoc, "XML Document not defined.");
547 548 549
            return *m_xmlDoc;
        }

550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569

        /**
         * 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.
570 571
         *
         * @return Direct pointer to requested XML Element.
572
         */
573 574 575
        TiXmlElement* SessionReader::GetElement(const string& pPath)
        {
            std::string vPath = boost::to_upper_copy(pPath);
576 577 578
            std::vector<std::string> st;
            boost::split(st, vPath, boost::is_any_of("\\/ "));
            ASSERTL0(st.size() > 0, "No path given in XML element request.");
579

580
            TiXmlElement* vReturn = m_xmlDoc->FirstChildElement(st[0].c_str());
581
            ASSERTL0(vReturn, std::string("Cannot find element '")
582 583
                              + st[0] + std::string("'."));
            for (int i = 1; i < st.size(); ++i)
584
            {
585
                vReturn = vReturn->FirstChildElement(st[i].c_str());
586
                ASSERTL0(vReturn, std::string("Cannot find element '")
587
                                  + st[i] + std::string("'."));
588 589 590 591
            }
            return vReturn;
        }

592 593 594 595 596

        /**
         *
         */
        bool SessionReader::DefinesElement(const std::string &pPath) const
597 598
        {
            std::string vPath = boost::to_upper_copy(pPath);
599 600 601
            std::vector<std::string> st;
            boost::split(st, vPath, boost::is_any_of("\\/ "));
            ASSERTL0(st.size() > 0, "No path given in XML element request.");
602

603
            TiXmlElement* vReturn = m_xmlDoc->FirstChildElement(st[0].c_str());
604
            ASSERTL0(vReturn, std::string("Cannot find element '")
605 606
                              + st[0] + std::string("'."));
            for (int i = 1; i < st.size(); ++i)
607
            {
608
                vReturn = vReturn->FirstChildElement(st[i].c_str());
609 610 611 612 613
                if (!vReturn) return false;
            }
            return true;
        }

614 615 616 617

        /**
         *
         */
618
        const std::vector<std::string>& SessionReader::GetFilenames() const
619
        {
620
            return m_filenames;
621 622
        }

623 624 625 626

        /**
         *
         */
627 628 629 630 631
        const std::string& SessionReader::GetSessionName() const
        {
            return m_sessionName;
        }

632

633 634 635 636 637 638
        /**
         * Output is of the form [sessionName]_P[idx] where idx is the rank
         * of the process.
         */
        const std::string SessionReader::GetSessionNameRank() const
        {
639
            std::string  dirname = m_sessionName + "_xml";
640
            fs::path     pdirname(dirname);
641

642
            std::string vFilename = "P" + boost::lexical_cast<std::string>(m_comm->GetRowComm()->GetRank());
643
            fs::path    pFilename(vFilename);
644

645 646 647 648
            fs::path fullpath = pdirname / pFilename;

            return PortablePath(fullpath);
        }
649

650 651 652
        /**
         *
         */
653 654 655 656 657
        CommSharedPtr& SessionReader::GetComm()
        {
            return m_comm;
        }

658 659 660 661
        bool SessionReader::GetSharedFilesystem()
        {
            return m_sharedFilesystem;
        }
662 663 664 665 666 667 668

        /**
         * This routine finalises any parallel communication.
         *
         * @note This routine should be called at the very end of a users
         * application.
         */
669 670 671 672 673
        void SessionReader::Finalise()
        {
            m_comm->Finalise();
        }

674

675 676 677 678 679 680
        /**
         *
         */
        bool SessionReader::DefinesParameter(const std::string& pName) const
        {
            std::string vName = boost::to_upper_copy(pName);
681
            return m_parameters.find(vName) != m_parameters.end();
682 683
        }

684 685 686 687 688 689 690 691 692

        /**
         * 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.
         */
693 694
        const NekDouble& SessionReader::GetParameter(
            const std::string& pName) const
695 696
        {
            std::string vName = boost::to_upper_copy(pName);
697
            auto paramIter = m_parameters.find(vName);
698

699 700
            ASSERTL0(paramIter != m_parameters.end(),
                     "Unable to find requested parameter: " + pName);
701

702
            return paramIter->second;
703 704
        }

705 706 707 708

        /**
         *
         */
709 710
        void SessionReader::LoadParameter(
            const std::string &pName, int &pVar) const
711 712
        {
            std::string vName = boost::to_upper_copy(pName);
713
            auto paramIter = m_parameters.find(vName);
714
            ASSERTL0(paramIter != m_parameters.end(), "Required parameter '" +
715
                     pName + "' not specified in session.");
716
            pVar = (int)round(paramIter->second);
717 718
        }

719 720 721 722

        /**
         *
         */
723 724
        void SessionReader::LoadParameter(
            const std::string &pName, int &pVar, const int &pDefault) const
725 726
        {
            std::string vName = boost::to_upper_copy(pName);
727
            auto paramIter = m_parameters.find(vName);
728
            if(paramIter != m_parameters.end())
729
            {
730
                pVar = (int)round(paramIter->second);
731 732 733 734 735 736 737
            }
            else
            {
                pVar  = pDefault;
            }
        }

738 739 740 741

        /**
         *
         */
742 743
        void SessionReader::LoadParameter(
            const std::string &pName, NekDouble& pVar) const
744 745
        {
            std::string vName = boost::to_upper_copy(pName);
746
            auto paramIter = m_parameters.find(vName);
747
            ASSERTL0(paramIter != m_parameters.end(), "Required parameter '" +
748 749
                     pName + "' not specified in session.");
            pVar = paramIter->second;
750 751
        }

752 753 754 755

        /**
         *
         */
756
        void SessionReader::LoadParameter(
757 758
            const std::string &pName,
                  NekDouble   &pVar,
759
            const NekDouble   &pDefault) const
760 761
        {
            std::string vName = boost::to_upper_copy(pName);
762
            auto paramIter = m_parameters.find(vName);
763
            if(paramIter != m_parameters.end())
764
            {
765
                pVar = paramIter->second;
766 767 768
            }
            else
            {
769
                pVar = pDefault;
770 771 772
            }
        }

773

Spencer Sherwin's avatar
Spencer Sherwin committed
774 775 776 777

        /**
         *
         */
778
        void SessionReader::SetParameter(const std::string &pName, int &pVar)
Spencer Sherwin's avatar
Spencer Sherwin committed
779 780 781 782 783 784 785 786 787
        {
            std::string vName = boost::to_upper_copy(pName);
            m_parameters[vName] = pVar;
        }


        /**
         *
         */
788
        void SessionReader::SetParameter(
789
            const std::string &pName, NekDouble& pVar)
Spencer Sherwin's avatar
Spencer Sherwin committed
790 791 792 793 794 795 796
        {
            std::string vName = boost::to_upper_copy(pName);
            m_parameters[vName] = pVar;
        }



797 798 799 800
        /**
         *
         */
        bool SessionReader::DefinesSolverInfo(const std::string &pName) const
801 802
        {
            std::string vName = boost::to_upper_copy(pName);
803
            auto infoIter = m_solverInfo.find(vName);
804
            return (infoIter != m_solverInfo.end());
805 806
        }

807 808 809 810

        /**
         *
         */
811 812
        const std::string& SessionReader::GetSolverInfo(
            const std::string &pProperty) const
813 814
        {
            std::string vProperty = boost::to_upper_copy(pProperty);
815
            auto iter = m_solverInfo.find(vProperty);
816

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

820
            return iter->second;
821 822
        }

Sergey Yakovlev's avatar
Sergey Yakovlev committed
823 824 825 826
        /**
         *
         */
        void SessionReader::SetSolverInfo(
827
            const std::string &pProperty, const std::string &pValue)
Sergey Yakovlev's avatar
Sergey Yakovlev committed
828 829
        {
            std::string vProperty = boost::to_upper_copy(pProperty);
830
            auto iter = m_solverInfo.find(vProperty);
Sergey Yakovlev's avatar
Sergey Yakovlev committed
831 832 833 834 835 836

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

            iter->second = pValue;
        }
837 838 839 840

        /**
         *
         */
841
        void SessionReader::LoadSolverInfo(
842 843
            const std::string &pName,
                  std::string &pVar,
844
            const std::string &pDefault) const
845 846
        {
            std::string vName = boost::to_upper_copy(pName);
847
            auto infoIter = m_solverInfo.find(vName);
848
            if(infoIter != m_solverInfo.end())
849
            {
850
                pVar = infoIter->second;
851 852 853
            }
            else
            {
854
                pVar = pDefault;
855 856 857
            }
        }

858 859 860 861

        /**
         *
         */
862 863 864 865 866
        void SessionReader::MatchSolverInfo(
            const std::string &pName,
            const std::string &pTrueVal,
                  bool        &pVar,
            const bool        &pDefault) const
867 868
        {
            std::string vName = boost::to_upper_copy(pName);
869
            auto infoIter = m_solverInfo.find(vName);
870
            if(infoIter != m_solverInfo.end())
871
            {
872
                pVar = boost::iequals(infoIter->second, pTrueVal);
873 874 875
            }
            else
            {
876
                pVar = pDefault;
877 878 879
            }
        }

880 881 882 883

        /**
         *
         */
884 885 886
        bool SessionReader::MatchSolverInfo(
            const std::string &pName,
            const std::string &pTrueVal) const
887 888 889 890
        {
            if (DefinesSolverInfo(pName))
            {
                std::string vName = boost::to_upper_copy(pName);
891
                auto iter = m_solverInfo.find(vName);
892
                if(iter != m_solverInfo.end())
893 894 895 896 897 898 899 900
                {
                    return true;
                }
            }
            return false;
        }


901 902 903
        /**
         *
         */
904
        bool SessionReader::DefinesGlobalSysSolnInfo(const std::string &pVariable,
905 906
                                                     const std::string &pProperty) const
        {
907
            auto iter = GetGloSysSolnList().find(pVariable);
908
            if(iter == GetGloSysSolnList().end())
909 910 911 912 913
            {
                return false;
            }

            std::string vProperty = boost::to_upper_copy(pProperty);
914

915
            auto iter1 = iter->second.find(vProperty);
916 917 918 919
            if(iter1 == iter->second.end())
            {
                return false;
            }
920

921 922 923
            return true;
        }

924

925 926 927 928 929
        /**
         *
         */
        const std::string &SessionReader::GetGlobalSysSolnInfo(const std::string &pVariable, const std::string &pProperty) const
        {
930 931 932
            auto iter = GetGloSysSolnList().find(pVariable);
            ASSERTL0(iter != GetGloSysSolnList().end(),
                     "Failed to find variable in GlobalSysSolnInfoList");
933 934

            std::string vProperty = boost::to_upper_copy(pProperty);
935
            auto iter1 = iter->second.find(vProperty);
936

937 938
            ASSERTL0(iter1 != iter->second.end(),
                     "Failed to find property: " + vProperty + " in GlobalSysSolnInfoList");
939

940 941
            return iter1->second;
        }
942

943 944 945 946
        /**
         *
         */
        bool SessionReader::DefinesGeometricInfo(const std::string &pName) const
947 948
        {
            std::string vName = boost::to_upper_copy(pName);
949
            return m_geometricInfo.find(vName) != m_geometricInfo.end();
950 951
        }

952 953 954 955

        /**
         *
         */
956 957 958 959
        void SessionReader::LoadGeometricInfo(
            const std::string &pName,
                  std::string &pVar,
            const std::string &pDefault) const
960 961
        {
            std::string vName = boost::to_upper_copy(pName);
962
            auto iter = m_geometricInfo.find(vName);
963
            if(iter != m_geometricInfo.end())
964
            {
965
                pVar = iter->second;
966 967 968
            }
            else
            {
969
                pVar = pDefault;
970 971 972
            }
        }

973 974 975 976

        /**
         *
         */
977 978 979 980
        void SessionReader::LoadGeometricInfo(
            const std::string &pName,
                  bool        &pVar,
            const bool        &pDefault) const
981 982
        {
            std::string vName = boost::to_upper_copy(pName);
983
            auto iter = m_geometricInfo.find(vName);
984
            if(iter != m_geometricInfo.end())
985
            {
986
                if (iter->second == "TRUE")
987 988 989 990 991 992 993 994 995 996
                {
                    pVar = true;
                }
                else
                {
                    pVar = false;
                }
            }
            else
            {
997
                pVar = pDefault;
998 999 1000
            }
        }

1001

1002 1003 1004
        /**
         *
         */
1005 1006 1007 1008
        void SessionReader::LoadGeometricInfo(
            const std::string &pName,
                  NekDouble   &pVar,
            const NekDouble   &pDefault) const
1009 1010
        {
            std::string vName = boost::to_upper_copy(pName);
1011
            auto iter = m_geometricInfo.find(vName);
1012
            if(iter != m_geometricInfo.end())
1013
            {
1014
                pVar = std::atoi(iter->second.c_str());
1015 1016 1017
            }
            else
            {
1018
                pVar = pDefault;
1019 1020 1021 1022
            }
        }


1023 1024 1025
        /**
         *
         */
1026 1027 1028 1029 1030
        void SessionReader::MatchGeometricInfo(
            const std::string &pName,
            const std::string &pTrueVal,
                  bool        &pVar,
            const bool        &pDefault) const
1031 1032
        {
            std::string vName = boost::to_upper_copy(pName);
1033
            auto iter = m_geometricInfo.find(vName);
1034
            if(iter != m_geometricInfo.end())
1035
            {
1036
                pVar = boost::iequals(iter->second, pTrueVal);
1037 1038 1039 1040 1041 1042 1043 1044
            }
            else
            {
                pVar  = pDefault;
            }
        }


1045 1046 1047
        /**
         *
         */
1048 1049
        const std::string& SessionReader::GetVariable(
            const unsigned int &idx) const
1050 1051 1052 1053 1054
        {
            ASSERTL0(idx < m_variables.size(), "Variable index out of range.");
            return m_variables[idx];
        }

1055

1056 1057 1058 1059

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


1068 1069 1070
        /**
         *
         */
1071 1072 1073 1074 1075
        std::vector<std::string> SessionReader::GetVariables() const
        {
            return m_variables;
        }

1076 1077 1078 1079 1080 1081 1082

        /**
         *
         */
        bool SessionReader::DefinesFunction(const std::string &pName) const
        {
            std::string vName = boost::to_upper_copy(pName);
1083
            return m_functions.find(vName) != m_functions.end();
1084 1085 1086 1087 1088 1089
        }


        /**
         *
         */
1090 1091
        bool SessionReader::DefinesFunction(
            const std::string &pName,
1092 1093
            const std::string &pVariable,
            const int pDomain) const
1094 1095 1096
        {
            std::string vName = boost::to_upper_copy(pName);

1097
            // Check function exists
1098 1099
            auto it1 = m_functions.find(vName);
            if (it1 != m_functions.end())
1100
            {
1101 1102
                pair<std::string, int> key(pVariable,pDomain);
                pair<std::string, int> defkey("*",pDomain);
1103
                bool varExists =
1104 1105
                    it1->second.find(key)    != it1->second.end() ||
                    it1->second.find(defkey) != it1->second.end();
1106
                return varExists;
1107 1108 1109 1110 1111 1112 1113 1114
            }
            return false;
        }


        /**
         *
         */
1115 1116
        EquationSharedPtr SessionReader::GetFunction(
            const std::string &pName,
1117 1118
            const std::string &pVariable,
            const int pDomain) const
1119 1120
        {
            std::string vName = boost::to_upper_copy(pName);
1121
            auto it1 = m_functions.find(vName);
1122

1123
            ASSERTL0(it1 != m_functions.end(),
1124 1125
                     std::string("No such function '") + pName
                     + std::string("' has been defined in the session file."));
1126 1127

            // Check for specific and wildcard definitions
1128 1129
            pair<std::string,int> key(pVariable,pDomain);
            pair<std::string,int> defkey("*",pDomain);
1130 1131 1132 1133 1134

            auto it2 = it1->second.find(key);
            auto it3 = it1->second.find(defkey);
            bool specific = it2 != it1->second.end();
            bool wildcard = it3 != it1->second.end();
1135 1136 1137

            // Check function is defined somewhere
            ASSERTL0(specific || wildcard,
1138
                     "No such variable " + pVariable
1139
                     + " in domain " + boost::lexical_cast<string>(pDomain)
1140 1141
                     + " defined for function " + pName
                     + " in session file.");
1142 1143 1144 1145 1146 1147 1148

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

1149
            ASSERTL0((it2->second.m_type == eFunctionTypeExpression),
1150
                    std::string("Function is defined by a file."));
1151
            return it2->second.m_expression;
1152 1153
        }

1154 1155 1156 1157

        /**
         *
         */
1158 1159
        EquationSharedPtr SessionReader::GetFunction(
            const std::string  &pName,
1160 1161
            const unsigned int &pVar,
            const int pDomain) const
1162 1163
        {
            ASSERTL0(pVar < m_variables.size(), "Variable index out of range.");
1164
            return GetFunction(pName, m_variables[pVar],pDomain);