SessionReader.cpp 95.9 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
#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.hpp>
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 154 155
        /**
         * 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. 
         */
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_filename    = m_filenames[0];
193
            m_sessionName = m_filename.substr(0, m_filename.find_last_of('.'));
194 195 196 197 198 199
            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('.'));
            }
200 201

            // Create communicator
202
            CreateComm(argc, argv);
203 204 205 206 207

            // If running in parallel change the default global sys solution
            // type.
            if (m_comm->GetSize() > 1)
            {
208
                GetSolverInfoDefaults()["GLOBALSYSSOLN"] = 
209 210
                    "IterativeStaticCond";
            }
211 212 213
        }


214 215 216
        /**
         *
         */
217 218 219 220 221
        SessionReader::SessionReader(
            int                             argc, 
            char                           *argv[], 
            const std::vector<std::string> &pFilenames, 
            const CommSharedPtr            &pComm)
222 223 224
        {
            ASSERTL0(pFilenames.size() > 0, "No filenames specified.");

225
            ParseCommandLineArguments(argc, argv);
Chris Cantwell's avatar
Chris Cantwell committed
226
            m_xmlDoc      = 0;
227
            m_filenames   = pFilenames;
228

229
            m_filename    = pFilenames[0];
230
            m_sessionName = m_filename.substr(0, m_filename.find_last_of('.'));
231 232 233 234 235 236
            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('.'));
            }
237

238
            // Create communicator
239 240
            if (!pComm.get())
            {
241
                CreateComm(argc, argv);
242 243 244 245
            }
            else
            {
                m_comm = pComm;
246 247 248

                if (m_comm->GetSize() > 1)
                {
249
                    GetSolverInfoDefaults()["GLOBALSYSSOLN"] = 
250 251
                        "IterativeStaticCond";
                }
252
            }
253 254 255 256 257

            // If running in parallel change the default global sys solution
            // type.
            if (m_comm->GetSize() > 1)
            {
258
                GetSolverInfoDefaults()["GLOBALSYSSOLN"] = 
259
                    "IterativeStaticCond";
260
            }
261 262 263
        }


264 265 266
        /**
         *
         */
267 268
        SessionReader::~SessionReader()
        {
269
            delete m_xmlDoc;
270 271
        }

272 273 274 275 276 277 278

        /**
         * 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.
         */
279 280
        void SessionReader::InitSession()
        {
281 282
            m_exprEvaluator.SetRandomSeed((m_comm->GetRank() + 1) * time(NULL));

283 284 285
            // Split up the communicator
            PartitionComm();

286 287 288
            // Partition mesh
            PartitionMesh();

289 290
            // Parse the XML data in #m_xmlDoc
            ParseDocument();
291 292 293 294

            // Override SOLVERINFO and parameters with any specified on the
            // command line.
            CmdLineOverride();
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320

            // 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;
                }
            }
321 322
        }

323

324
        /**
325 326
         * @brief Parses the command-line arguments for known options and
         * filenames.
327
         */
328 329
        std::vector<std::string> SessionReader::ParseCommandLineArguments(
            int argc, char *argv[])
330 331 332 333
        {
            // List the publically visible options (listed using --help)
            po::options_description desc("Allowed options");
            desc.add_options()
334
                ("verbose,v",    "be verbose")
335
                ("version,V",    "print version information")
336 337 338 339 340
                ("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")
341
                ("shared-filesystem,s", "Using shared filesystem.")
342 343 344 345 346 347
                ("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")
348 349
                ("part-only",    po::value<int>(),
                                 "only partition mesh into N partitions.")
350
                ("part-info",    "Output partition information")
351
            ;
352
            
353
            CmdLineArgMap::const_iterator cmdIt;
354 355
            for (cmdIt  = GetCmdLineArgMap().begin();
                 cmdIt != GetCmdLineArgMap().end(); ++cmdIt)
356 357 358 359 360 361
            {
                std::string names = cmdIt->first;
                if (cmdIt->second.shortName != "")
                {
                    names += "," + cmdIt->second.shortName;
                }
362 363 364 365 366 367 368 369 370 371 372 373 374
                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())
                    ;
                }
375
            }
376 377 378 379 380

            // 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()
381 382
                    ("input-file", po::value< vector<string> >(), 
                                   "input filename")
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
            ;

            // 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"))
            {
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
                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
422 423 424 425 426 427 428 429 430 431 432 433
                    cout << " (git changeset " << sha1.substr(0, 8) << ", ";

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

                    cout << ")";
434 435 436
                }

                cout << endl;
437 438 439 440 441 442 443 444 445 446 447 448
                exit(0);
            }

            // Enable verbose mode
            if (m_cmdLineOptions.count("verbose"))
            {
                m_verbose = true;
            }
            else
            {
                m_verbose = false;
            }
449
            
450 451 452 453 454 455
            // 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)
                {
456 457
                    cout << "Warning: Unknown option: " << x->string_key 
                         << endl;
458 459 460 461 462 463
                }
            }

            // Return the vector of filename(s) given as positional options
            if (m_cmdLineOptions.count("input-file"))
            {
464 465
                return m_cmdLineOptions["input-file"].as<
                    std::vector<std::string> >();
466 467 468 469 470 471 472 473
            }
            else
            {
                return std::vector<std::string>();
            }
        }


474 475 476
        /**
         *
         */
477 478
        TiXmlDocument& SessionReader::GetDocument()
        {
479
            ASSERTL1(m_xmlDoc, "XML Document not defined.");
480 481 482
            return *m_xmlDoc;
        }

483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502

        /**
         * 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.
503 504
         *
         * @return Direct pointer to requested XML Element.
505
         */
506 507 508
        TiXmlElement* SessionReader::GetElement(const string& pPath)
        {
            std::string vPath = boost::to_upper_copy(pPath);
509 510 511
            std::vector<std::string> st;
            boost::split(st, vPath, boost::is_any_of("\\/ "));
            ASSERTL0(st.size() > 0, "No path given in XML element request.");
512

513
            TiXmlElement* vReturn = m_xmlDoc->FirstChildElement(st[0].c_str());
514
            ASSERTL0(vReturn, std::string("Cannot find element '")
515 516
                              + st[0] + std::string("'."));
            for (int i = 1; i < st.size(); ++i)
517
            {
518
                vReturn = vReturn->FirstChildElement(st[i].c_str());
519
                ASSERTL0(vReturn, std::string("Cannot find element '")
520
                                  + st[i] + std::string("'."));
521 522 523 524
            }
            return vReturn;
        }

525 526 527 528 529

        /**
         *
         */
        bool SessionReader::DefinesElement(const std::string &pPath) const
530 531
        {
            std::string vPath = boost::to_upper_copy(pPath);
532 533 534
            std::vector<std::string> st;
            boost::split(st, vPath, boost::is_any_of("\\/ "));
            ASSERTL0(st.size() > 0, "No path given in XML element request.");
535

536
            TiXmlElement* vReturn = m_xmlDoc->FirstChildElement(st[0].c_str());
537
            ASSERTL0(vReturn, std::string("Cannot find element '")
538 539
                              + st[0] + std::string("'."));
            for (int i = 1; i < st.size(); ++i)
540
            {
541
                vReturn = vReturn->FirstChildElement(st[i].c_str());
542 543 544 545 546
                if (!vReturn) return false;
            }
            return true;
        }

547 548 549 550

        /**
         *
         */
551
        const std::string& SessionReader::GetFilename() const
552 553 554 555
        {
            return m_filename;
        }

556 557 558 559

        /**
         *
         */
560 561 562 563 564
        const std::string& SessionReader::GetSessionName() const
        {
            return m_sessionName;
        }

565

566 567 568 569 570 571
        /**
         * Output is of the form [sessionName]_P[idx] where idx is the rank
         * of the process.
         */
        const std::string SessionReader::GetSessionNameRank() const
        {
572
            std::string  dirname = m_sessionName + "_xml"; 
573 574
            fs::path     pdirname(dirname);
            
575
            std::string vFilename = "P" + boost::lexical_cast<std::string>(m_comm->GetRowComm()->GetRank());
576
            fs::path    pFilename(vFilename);            
577

578
            fs::path fullpath = pdirname / pFilename;
579

580 581
            return PortablePath(fullpath);
        }
582

583 584 585
        /**
         *
         */
586 587 588 589 590
        CommSharedPtr& SessionReader::GetComm()
        {
            return m_comm;
        }

591 592 593 594 595 596 597

        /**
         * This routine finalises any parallel communication.
         *
         * @note This routine should be called at the very end of a users
         * application.
         */
598 599 600 601 602
        void SessionReader::Finalise()
        {
            m_comm->Finalise();
        }

603

604 605 606 607 608 609
        /**
         *
         */
        bool SessionReader::DefinesParameter(const std::string& pName) const
        {
            std::string vName = boost::to_upper_copy(pName);
610 611
            ParameterMap::const_iterator paramIter = m_parameters.find(vName);
            return (paramIter != m_parameters.end());
612 613
        }

614 615 616 617 618 619 620 621 622

        /**
         * 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.
         */
623 624
        const NekDouble& SessionReader::GetParameter(
            const std::string& pName) const
625 626
        {
            std::string vName = boost::to_upper_copy(pName);
627
            ParameterMap::const_iterator paramIter = m_parameters.find(vName);
628

629 630
            ASSERTL0(paramIter != m_parameters.end(),
                     "Unable to find requested parameter: " + pName);
631

632
            return paramIter->second;
633 634
        }

635 636 637 638

        /**
         *
         */
639 640
        void SessionReader::LoadParameter(
            const std::string &pName, int &pVar) const
641 642
        {
            std::string vName = boost::to_upper_copy(pName);
643 644 645 646
            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);
647 648
        }

649 650 651 652

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

668 669 670 671

        /**
         *
         */
672 673
        void SessionReader::LoadParameter(
            const std::string &pName, NekDouble& pVar) const
674 675
        {
            std::string vName = boost::to_upper_copy(pName);
676 677 678 679
            ParameterMap::const_iterator paramIter = m_parameters.find(vName);
            ASSERTL0(paramIter != m_parameters.end(), "Required parameter '" + 
                     pName + "' not specified in session.");
            pVar = paramIter->second;
680 681
        }

682 683 684 685

        /**
         *
         */
686 687 688 689
        void SessionReader::LoadParameter(
            const std::string &pName, 
                  NekDouble   &pVar, 
            const NekDouble   &pDefault) const
690 691
        {
            std::string vName = boost::to_upper_copy(pName);
692 693
            ParameterMap::const_iterator paramIter = m_parameters.find(vName);
            if(paramIter != m_parameters.end())
694
            {
695
                pVar = paramIter->second;
696 697 698
            }
            else
            {
699
                pVar = pDefault;
700 701 702
            }
        }

703

Spencer Sherwin's avatar
Spencer Sherwin committed
704 705 706 707 708 709 710 711 712 713 714 715 716 717

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


        /**
         *
         */
718 719
        void SessionReader::SetParameter(
            const std::string &pName, NekDouble& pVar) 
Spencer Sherwin's avatar
Spencer Sherwin committed
720 721 722 723 724 725 726
        {
            std::string vName = boost::to_upper_copy(pName);
            m_parameters[vName] = pVar;
        }



727 728 729 730
        /**
         *
         */
        bool SessionReader::DefinesSolverInfo(const std::string &pName) const
731 732
        {
            std::string vName = boost::to_upper_copy(pName);
733 734
            SolverInfoMap::const_iterator infoIter = m_solverInfo.find(vName);
            return (infoIter != m_solverInfo.end());
735 736
        }

737 738 739 740

        /**
         *
         */
741 742
        const std::string& SessionReader::GetSolverInfo(
            const std::string &pProperty) const
743 744
        {
            std::string vProperty = boost::to_upper_copy(pProperty);
745
            SolverInfoMap::const_iterator iter = m_solverInfo.find(vProperty);
746

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

750
            return iter->second;
751 752
        }

Sergey Yakovlev's avatar
Sergey Yakovlev committed
753 754 755 756 757 758 759 760 761 762 763 764 765 766
        /**
         *
         */
        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;
        }
767 768 769 770

        /**
         *
         */
771 772 773 774
        void SessionReader::LoadSolverInfo(
            const std::string &pName, 
                  std::string &pVar, 
            const std::string &pDefault) const
775 776
        {
            std::string vName = boost::to_upper_copy(pName);
777 778
            SolverInfoMap::const_iterator infoIter = m_solverInfo.find(vName);
            if(infoIter != m_solverInfo.end())
779
            {
780
                pVar = infoIter->second;
781 782 783
            }
            else
            {
784
                pVar = pDefault;
785 786 787
            }
        }

788 789 790 791

        /**
         *
         */
792 793 794 795 796
        void SessionReader::MatchSolverInfo(
            const std::string &pName,
            const std::string &pTrueVal,
                  bool        &pVar,
            const bool        &pDefault) const
797 798
        {
            std::string vName = boost::to_upper_copy(pName);
799 800
            SolverInfoMap::const_iterator infoIter = m_solverInfo.find(vName);
            if(infoIter != m_solverInfo.end())
801
            {
802
                pVar = boost::iequals(infoIter->second, pTrueVal);
803 804 805
            }
            else
            {
806
                pVar = pDefault;
807 808 809
            }
        }

810 811 812 813

        /**
         *
         */
814 815 816
        bool SessionReader::MatchSolverInfo(
            const std::string &pName,
            const std::string &pTrueVal) const
817 818 819 820
        {
            if (DefinesSolverInfo(pName))
            {
                std::string vName = boost::to_upper_copy(pName);
821 822
                SolverInfoMap::const_iterator iter = m_solverInfo.find(vName);
                if(iter != m_solverInfo.end())
823 824 825 826 827 828 829 830
                {
                    return true;
                }
            }
            return false;
        }


831 832 833 834 835 836 837
        /**
         *
         */
        bool SessionReader::DefinesGlobalSysSolnInfo(const std::string &pVariable, 
                                                     const std::string &pProperty) const
        {

838 839 840
            GloSysSolnInfoList::const_iterator iter =
                    GetGloSysSolnList().find(pVariable);
            if(iter == GetGloSysSolnList().end())
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
            {
                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; 

864 865
            ASSERTL0( (iter = GetGloSysSolnList().find(pVariable)) !=
                              GetGloSysSolnList().end(),
866 867 868 869 870 871 872 873 874 875 876
                      "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;
        }
        
877 878 879 880
        /**
         *
         */
        bool SessionReader::DefinesGeometricInfo(const std::string &pName) const
881 882
        {
            std::string vName = boost::to_upper_copy(pName);
883 884
            GeometricInfoMap::const_iterator iter = m_geometricInfo.find(vName);
            return (iter != m_geometricInfo.end());
885 886
        }

887 888 889 890

        /**
         *
         */
891 892 893 894
        void SessionReader::LoadGeometricInfo(
            const std::string &pName,
                  std::string &pVar,
            const std::string &pDefault) const
895 896
        {
            std::string vName = boost::to_upper_copy(pName);
897 898
            GeometricInfoMap::const_iterator iter = m_geometricInfo.find(vName);
            if(iter != m_geometricInfo.end())
899
            {
900
                pVar = iter->second;
901 902 903
            }
            else
            {
904
                pVar = pDefault;
905 906 907
            }
        }

908 909 910 911

        /**
         *
         */
912 913 914 915
        void SessionReader::LoadGeometricInfo(
            const std::string &pName,
                  bool        &pVar,
            const bool        &pDefault) const
916 917
        {
            std::string vName = boost::to_upper_copy(pName);
918 919
            GeometricInfoMap::const_iterator iter = m_geometricInfo.find(vName);
            if(iter != m_geometricInfo.end())
920
            {
921
                if (iter->second == "TRUE")
922 923 924 925 926 927 928 929 930 931
                {
                    pVar = true;
                }
                else
                {
                    pVar = false;
                }
            }
            else
            {
932
                pVar = pDefault;
933 934 935
            }
        }

936

937 938 939
        /**
         *
         */
940 941 942 943
        void SessionReader::LoadGeometricInfo(
            const std::string &pName,
                  NekDouble   &pVar,
            const NekDouble   &pDefault) const
944 945
        {
            std::string vName = boost::to_upper_copy(pName);
946 947
            GeometricInfoMap::const_iterator iter = m_geometricInfo.find(vName);
            if(iter != m_geometricInfo.end())
948
            {
949
                pVar = std::atoi(iter->second.c_str());
950 951 952
            }
            else
            {
953
                pVar = pDefault;
954 955 956 957
            }
        }


958 959 960
        /**
         *
         */
961 962 963 964 965
        void SessionReader::MatchGeometricInfo(
            const std::string &pName,
            const std::string &pTrueVal,
                  bool        &pVar,
            const bool        &pDefault) const
966 967
        {
            std::string vName = boost::to_upper_copy(pName);
968 969
            GeometricInfoMap::const_iterator iter = m_geometricInfo.find(vName);
            if(iter != m_geometricInfo.end())
970
            {
971
                pVar = boost::iequals(iter->second, pTrueVal);
972 973 974 975 976 977 978 979
            }
            else
            {
                pVar  = pDefault;
            }
        }


980 981 982
        /**
         *
         */
983 984
        const std::string& SessionReader::GetVariable(
            const unsigned int &idx) const
985 986 987 988 989
        {
            ASSERTL0(idx < m_variables.size(), "Variable index out of range.");
            return m_variables[idx];
        }

990

991 992 993 994 995 996 997 998 999 1000 1001 1002

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


1003 1004 1005
        /**
         *
         */
1006 1007 1008 1009 1010
        std::vector<std::string> SessionReader::GetVariables() const
        {
            return m_variables;
        }

1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030

        /**
         *
         */
        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;
        }


        /**
         *
         */
1031 1032
        bool SessionReader::DefinesFunction(
            const std::string &pName,
1033 1034
            const std::string &pVariable,
            const int pDomain) const
1035 1036
        {
            FunctionMap::const_iterator it1;
1037
            FunctionVariableMap::const_iterator it2;
1038 1039
            std::string vName = boost::to_upper_copy(pName);

1040 1041
            // Check function exists
            if ((it1 = m_functions.find(vName))     != m_functions.end())
1042
            {
1043 1044
                pair<std::string, int> key(pVariable,pDomain);
                pair<std::string, int> defkey("*",pDomain);
1045
                bool varExists =
1046 1047
                    (it2 = it1->second.find(key)) != it1->second.end() ||
                    (it2 = it1->second.find(defkey)) != it1->second.end();
1048
                return varExists;
1049 1050 1051 1052 1053 1054 1055 1056
            }
            return false;
        }


        /**
         *
         */
1057 1058
        EquationSharedPtr SessionReader::GetFunction(
            const std::string &pName,
1059 1060
            const std::string &pVariable,
            const int pDomain) const
1061 1062
        {
            FunctionMap::const_iterator it1;
1063
            FunctionVariableMap::const_iterator it2, it3;
1064 1065 1066 1067 1068
            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."));
1069 1070

            // Check for specific and wildcard definitions
1071 1072 1073 1074 1075 1076
            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();
1077 1078 1079

            // Check function is defined somewhere
            ASSERTL0(specific || wildcard,
1080 1081 1082 1083
                     "No such variable " + pVariable
                     + " in domain " + boost::lexical_cast<string>(pDomain) 
                     + " defined for function " + pName
                     + " in session file.");
1084 1085 1086 1087 1088 1089 1090

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

1091
            ASSERTL0((it2->second.m_type == eFunctionTypeExpression),
1092
                    std::string("Function is defined by a file."));
1093
            return it2->second.m_expression;
1094 1095
        }

1096 1097 1098 1099

        /**
         *
         */
1100 1101
        EquationSharedPtr SessionReader::GetFunction(
            const std::string  &pName,
1102 1103
            const unsigned int &pVar,
            const int pDomain) const
1104 1105
        {
            ASSERTL0(pVar < m_variables.size(), "Variable index out of range.");
1106
            return GetFunction(pName, m_variables[pVar],pDomain);
1107 1108
        }

1109 1110 1111 1112

        /**
         *
         */
1113 1114
        enum FunctionType SessionReader::GetFunctionType(
            const std::string &pName,
1115 1116
            const std::string &pVariable,
            const int pDomain) const
1117 1118
        {
            FunctionMap::const_iterator it1;
1119
            FunctionVariableMap::const_iterator it2, it3;
1120 1121 1122 1123 1124 1125
            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."));
1126 1127

            // Check for specific and wildcard definitions
1128 1129 1130
            pair<std::string,int> key(pVariable,pDomain);
            pair<std::string,int> defkey("*",pDomain);
            bool specific = (it2 = it1->second.find(key)) !=
1131
                            it1->second.end();
1132
            bool wildcard = (it3 = it1->second.find(defkey)) !=
1133 1134 1135 1136
                            it1->second.end();

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

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

1148
            return it2->second.m_type;
1149 1150
        }

1151 1152 1153 1154

        /**
         *
         */
1155 1156
        enum FunctionType SessionReader::GetFunctionType(
            const std::string  &pName,
1157 1158
            const unsigned int &pVar,
            const int pDomain) const
1159 1160
        {
            ASSERTL0(pVar < m_variables.size(), "Variable index out of range.");
1161
            return GetFunctionType(pName, m_variables[pVar],pDomain);
1162 1163 1164 1165 1166 1167
        }


        /**
         *
         */
1168 1169
        std::string SessionReader::GetFunctionFilename(
            const std::string &pName, 
1170 1171
            const std::string &pVariable,
            const int pDomain) const
1172 1173
        {
            FunctionMap::const_iterator it1;
1174
            FunctionVariableMap::const_iterator it2, it3;
1175 1176 1177 1178 1179 1180
            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."));
1181 1182

            // Check for specific and wildcard definitions
1183 1184 1185
            pair<std::string,int> key(pVariable,pDomain);
            pair<std::string,int> defkey("*",pDomain);
            bool specific = (it2 = it1->second.find(key)) !=
1186
                            it1->second.end();
1187
            bool wildcard = (it3 = it1->second.find(defkey)) !=
1188 1189 1190 1191
                            it1->second.end();

            // Check function is defined somewhere
            ASSERTL0(specific || wildcard,
1192 1193 1194 1195 1196
                     "No such variable " + pVariable
                     + " in domain " + boost::lexical_cast<string>(pDomain) 
                     + " defined for function " + pName
                     + " in session file.");
            
1197 1198 1199 1200 1201 1202
            // If not specific, must be wildcard
            if (!specific)
            {
                it2 = it3;
            }

1203 1204 1205 1206 1207 1208 1209
            return it2->second.m_filename;
        }


        /**
         *
         */
1210 1211
        std::string SessionReader::GetFunctionFilename(
            const std::string  &pName, 
1212 1213
            const unsigned int &pVar,
            const int pDomain) const
1214 1215
        {
            ASSERTL0(pVar < m_variables.size(), "Variable index out of range.");
1216
            return GetFunctionFilename(pName, m_variables[pVar],pDomain);
1217 1218 1219
        }


1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
        /**
         *
         */
        std::string SessionReader::GetFunctionFilenameVariable(
            const std::string &pName,
            const std::string &pVariable,
            const int pDomain) const
        {
            FunctionMap::const_iterator it1;
            FunctionVariableMap::const_iterator it2, it3;
            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."));

            // Check for specific and wildcard definitions
            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();

            // Check function is defined somewhere
            ASSERTL0(specific || wildcard,
                     "No such variable " + pVariable
                     + " in domain " + boost::lexical_cast<string>(pDomain)
                     + " defined for function " + pName
                     + " in session file.");

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

            return it2->second.m_fileVariable;
        }


1262 1263 1264 1265 1266 1267 1268 1269 1270
        /**
         *
         */
        AnalyticExpressionEvaluator& SessionReader::GetExpressionEvaluator()
        {
            return m_exprEvaluator;
        }


1271 1272 1273 1274
        /**
         *
         */
        bool SessionReader::DefinesTag(const std::string &pName) const
1275 1276
        {
            std::string vName = boost::to_upper_copy(pName);
1277
            TagMap::const_iterator vTagIterator = m_tags.find(vName);
1278 1279 1280
            return (vTagIterator != m_tags.end());
        }

1281 1282 1283 1284

        /**
         *
         */
1285 1286 1287
        void SessionReader::SetTag(
            const std::string &pName, 
            const std::string &pValue)
1288 1289 1290 1291 1292
        {
            std::string vName = boost::to_upper_copy(pName);
            m_tags[vName] = pValue;
        }

1293 1294 1295 1296 1297

        /**
         *
         */
        const std::string &SessionReader::GetTag(const std::string& pName) const
1298 1299
        {
            std::string vName = boost::to_upper_copy(pName);
1300
            TagMap::const_iterator vTagIterator = m_tags.find(vName);
1301 1302 1303 1304 1305
            ASSERTL0(vTagIterator != m_tags.end(),
                     "Requested tag does not exist.");
            return vTagIterator->second;
        }

1306

1307 1308 1309 1310 1311 1312 1313 1314 1315
        /**
         *
         */
        const FilterMap &SessionReader::GetFilters() const
        {
            return m_filters;
        }


1316 1317 1318
        /**
         *
         */
1319 1320
        bool SessionReader::DefinesCmdLineArgument(
            const std::string& pName) const
1321 1322 1323 1324 1325
        {
            return (m_cmdLineOptions.find(pName) != m_cmdLineOptions.end());
        }


1326 1327 1328 1329 1330 1331
        /**
         *
         */
        void SessionReader::SubstituteExpressions(std::string& pExpr)
        {
            ExpressionMap::iterator exprIter;
1332 1333
            for (exprIter  = m_expressions.begin(); 
                 exprIter != m_expressions.end(); ++exprIter)
1334 1335 1336 1337 1338
            {
                boost::replace_all(pExpr, exprIter->first, exprIter->second);
            }
        }

1339