SessionReader.cpp 94.4 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.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
        /**
         * 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 199 200

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


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

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

222
            m_sessionName = ParseSessionName(m_filenames);
223

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

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

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


250 251 252
        /**
         *
         */
253 254
        SessionReader::~SessionReader()
        {
255
            delete m_xmlDoc;
256 257
        }

258 259 260 261 262 263 264

        /**
         * 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.
         */
265 266
        void SessionReader::InitSession()
        {
267 268
            m_exprEvaluator.SetRandomSeed((m_comm->GetRank() + 1) * time(NULL));

269 270 271
            // Split up the communicator
            PartitionComm();

272 273 274
            // Partition mesh
            PartitionMesh();

275 276
            // Parse the XML data in #m_xmlDoc
            ParseDocument();
277 278 279 280

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

282 283 284
            // Verify SOLVERINFO values
            VerifySolverInfo();

285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
            // 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;
                }
            }
310 311
        }

312

313
        /**
314 315
         * @brief Parses the command-line arguments for known options and
         * filenames.
316
         */
317 318
        std::vector<std::string> SessionReader::ParseCommandLineArguments(
            int argc, char *argv[])
319 320 321 322
        {
            // List the publically visible options (listed using --help)
            po::options_description desc("Allowed options");
            desc.add_options()
323
                ("verbose,v",    "be verbose")
324
                ("version,V",    "print version information")
325
                ("help,h",       "print this help message")
326
                ("solverinfo,I", po::value<vector<std::string> >(),
327 328 329
                                 "override a SOLVERINFO property")
                ("parameter,P",  po::value<vector<std::string> >(),
                                 "override a parameter")
330
                ("shared-filesystem,s", "Using shared filesystem.")
331 332 333 334 335 336
                ("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")
337
                ("nsz",          po::value<int>(),
338
                                 "number of slices in Z-dir")
339 340
                ("part-only",    po::value<int>(),
                                 "only partition mesh into N partitions.")
341 342
                ("part-only-overlapping",    po::value<int>(),
                                 "only partition mesh into N overlapping partitions.")
343
                ("part-info",    "Output partition information")
344
            ;
345

346
            CmdLineArgMap::const_iterator cmdIt;
347 348
            for (cmdIt  = GetCmdLineArgMap().begin();
                 cmdIt != GetCmdLineArgMap().end(); ++cmdIt)
349 350 351 352 353 354
            {
                std::string names = cmdIt->first;
                if (cmdIt->second.shortName != "")
                {
                    names += "," + cmdIt->second.shortName;
                }
355 356 357 358 359 360 361 362 363 364 365 366 367
                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())
                    ;
                }
368
            }
369 370 371 372 373

            // 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()
374
                    ("input-file", po::value< vector<string> >(),
375
                                   "input filename")
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
            ;

            // 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"))
            {
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
                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
415 416 417 418 419 420 421 422 423 424 425 426
                    cout << " (git changeset " << sha1.substr(0, 8) << ", ";

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

                    cout << ")";
427 428 429
                }

                cout << endl;
430 431 432 433 434 435 436 437 438 439 440 441
                exit(0);
            }

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

443 444 445 446 447 448
            // 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)
                {
449
                    cout << "Warning: Unknown option: " << x->string_key
450
                         << endl;
451 452 453 454 455 456
                }
            }

            // Return the vector of filename(s) given as positional options
            if (m_cmdLineOptions.count("input-file"))
            {
457 458
                return m_cmdLineOptions["input-file"].as<
                    std::vector<std::string> >();
459 460 461 462 463 464 465 466
            }
            else
            {
                return std::vector<std::string>();
            }
        }


467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
        /**
         *
         */
        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;
        }


505 506 507
        /**
         *
         */
508 509
        TiXmlDocument& SessionReader::GetDocument()
        {
510
            ASSERTL1(m_xmlDoc, "XML Document not defined.");
511 512 513
            return *m_xmlDoc;
        }

514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533

        /**
         * 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.
534 535
         *
         * @return Direct pointer to requested XML Element.
536
         */
537 538 539
        TiXmlElement* SessionReader::GetElement(const string& pPath)
        {
            std::string vPath = boost::to_upper_copy(pPath);
540 541 542
            std::vector<std::string> st;
            boost::split(st, vPath, boost::is_any_of("\\/ "));
            ASSERTL0(st.size() > 0, "No path given in XML element request.");
543

544
            TiXmlElement* vReturn = m_xmlDoc->FirstChildElement(st[0].c_str());
545
            ASSERTL0(vReturn, std::string("Cannot find element '")
546 547
                              + st[0] + std::string("'."));
            for (int i = 1; i < st.size(); ++i)
548
            {
549
                vReturn = vReturn->FirstChildElement(st[i].c_str());
550
                ASSERTL0(vReturn, std::string("Cannot find element '")
551
                                  + st[i] + std::string("'."));
552 553 554 555
            }
            return vReturn;
        }

556 557 558 559 560

        /**
         *
         */
        bool SessionReader::DefinesElement(const std::string &pPath) const
561 562
        {
            std::string vPath = boost::to_upper_copy(pPath);
563 564 565
            std::vector<std::string> st;
            boost::split(st, vPath, boost::is_any_of("\\/ "));
            ASSERTL0(st.size() > 0, "No path given in XML element request.");
566

567
            TiXmlElement* vReturn = m_xmlDoc->FirstChildElement(st[0].c_str());
568
            ASSERTL0(vReturn, std::string("Cannot find element '")
569 570
                              + st[0] + std::string("'."));
            for (int i = 1; i < st.size(); ++i)
571
            {
572
                vReturn = vReturn->FirstChildElement(st[i].c_str());
573 574 575 576 577
                if (!vReturn) return false;
            }
            return true;
        }

578 579 580 581

        /**
         *
         */
582
        const std::vector<std::string>& SessionReader::GetFilenames() const
583
        {
584
            return m_filenames;
585 586
        }

587 588 589 590

        /**
         *
         */
591 592 593 594 595
        const std::string& SessionReader::GetSessionName() const
        {
            return m_sessionName;
        }

596

597 598 599 600 601 602
        /**
         * Output is of the form [sessionName]_P[idx] where idx is the rank
         * of the process.
         */
        const std::string SessionReader::GetSessionNameRank() const
        {
603
            std::string  dirname = m_sessionName + "_xml";
604
            fs::path     pdirname(dirname);
605

606
            std::string vFilename = "P" + boost::lexical_cast<std::string>(m_comm->GetRowComm()->GetRank());
607
            fs::path    pFilename(vFilename);
608

609 610 611 612
            fs::path fullpath = pdirname / pFilename;

            return PortablePath(fullpath);
        }
613

614 615 616
        /**
         *
         */
617 618 619 620 621
        CommSharedPtr& SessionReader::GetComm()
        {
            return m_comm;
        }

622 623 624 625 626 627 628

        /**
         * This routine finalises any parallel communication.
         *
         * @note This routine should be called at the very end of a users
         * application.
         */
629 630 631 632 633
        void SessionReader::Finalise()
        {
            m_comm->Finalise();
        }

634

635 636 637 638 639 640
        /**
         *
         */
        bool SessionReader::DefinesParameter(const std::string& pName) const
        {
            std::string vName = boost::to_upper_copy(pName);
641 642
            ParameterMap::const_iterator paramIter = m_parameters.find(vName);
            return (paramIter != m_parameters.end());
643 644
        }

645 646 647 648 649 650 651 652 653

        /**
         * 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.
         */
654 655
        const NekDouble& SessionReader::GetParameter(
            const std::string& pName) const
656 657
        {
            std::string vName = boost::to_upper_copy(pName);
658
            ParameterMap::const_iterator paramIter = m_parameters.find(vName);
659

660 661
            ASSERTL0(paramIter != m_parameters.end(),
                     "Unable to find requested parameter: " + pName);
662

663
            return paramIter->second;
664 665
        }

666 667 668 669

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

680 681 682 683

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

699 700 701 702

        /**
         *
         */
703 704
        void SessionReader::LoadParameter(
            const std::string &pName, NekDouble& pVar) const
705 706
        {
            std::string vName = boost::to_upper_copy(pName);
707
            ParameterMap::const_iterator paramIter = m_parameters.find(vName);
708
            ASSERTL0(paramIter != m_parameters.end(), "Required parameter '" +
709 710
                     pName + "' not specified in session.");
            pVar = paramIter->second;
711 712
        }

713 714 715 716

        /**
         *
         */
717
        void SessionReader::LoadParameter(
718 719
            const std::string &pName,
                  NekDouble   &pVar,
720
            const NekDouble   &pDefault) const
721 722
        {
            std::string vName = boost::to_upper_copy(pName);
723 724
            ParameterMap::const_iterator paramIter = m_parameters.find(vName);
            if(paramIter != m_parameters.end())
725
            {
726
                pVar = paramIter->second;
727 728 729
            }
            else
            {
730
                pVar = pDefault;
731 732 733
            }
        }

734

Spencer Sherwin's avatar
Spencer Sherwin committed
735 736 737 738

        /**
         *
         */
739
        void SessionReader::SetParameter(const std::string &pName, int &pVar)
Spencer Sherwin's avatar
Spencer Sherwin committed
740 741 742 743 744 745 746 747 748
        {
            std::string vName = boost::to_upper_copy(pName);
            m_parameters[vName] = pVar;
        }


        /**
         *
         */
749
        void SessionReader::SetParameter(
750
            const std::string &pName, NekDouble& pVar)
Spencer Sherwin's avatar
Spencer Sherwin committed
751 752 753 754 755 756 757
        {
            std::string vName = boost::to_upper_copy(pName);
            m_parameters[vName] = pVar;
        }



758 759 760 761
        /**
         *
         */
        bool SessionReader::DefinesSolverInfo(const std::string &pName) const
762 763
        {
            std::string vName = boost::to_upper_copy(pName);
764 765
            SolverInfoMap::const_iterator infoIter = m_solverInfo.find(vName);
            return (infoIter != m_solverInfo.end());
766 767
        }

768 769 770 771

        /**
         *
         */
772 773
        const std::string& SessionReader::GetSolverInfo(
            const std::string &pProperty) const
774 775
        {
            std::string vProperty = boost::to_upper_copy(pProperty);
776
            SolverInfoMap::const_iterator iter = m_solverInfo.find(vProperty);
777

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

781
            return iter->second;
782 783
        }

Sergey Yakovlev's avatar
Sergey Yakovlev committed
784 785 786 787
        /**
         *
         */
        void SessionReader::SetSolverInfo(
788
            const std::string &pProperty, const std::string &pValue)
Sergey Yakovlev's avatar
Sergey Yakovlev committed
789 790 791 792 793 794 795 796 797
        {
            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;
        }
798 799 800 801

        /**
         *
         */
802
        void SessionReader::LoadSolverInfo(
803 804
            const std::string &pName,
                  std::string &pVar,
805
            const std::string &pDefault) const
806 807
        {
            std::string vName = boost::to_upper_copy(pName);
808 809
            SolverInfoMap::const_iterator infoIter = m_solverInfo.find(vName);
            if(infoIter != m_solverInfo.end())
810
            {
811
                pVar = infoIter->second;
812 813 814
            }
            else
            {
815
                pVar = pDefault;
816 817 818
            }
        }

819 820 821 822

        /**
         *
         */
823 824 825 826 827
        void SessionReader::MatchSolverInfo(
            const std::string &pName,
            const std::string &pTrueVal,
                  bool        &pVar,
            const bool        &pDefault) const
828 829
        {
            std::string vName = boost::to_upper_copy(pName);
830 831
            SolverInfoMap::const_iterator infoIter = m_solverInfo.find(vName);
            if(infoIter != m_solverInfo.end())
832
            {
833
                pVar = boost::iequals(infoIter->second, pTrueVal);
834 835 836
            }
            else
            {
837
                pVar = pDefault;
838 839 840
            }
        }

841 842 843 844

        /**
         *
         */
845 846 847
        bool SessionReader::MatchSolverInfo(
            const std::string &pName,
            const std::string &pTrueVal) const
848 849 850 851
        {
            if (DefinesSolverInfo(pName))
            {
                std::string vName = boost::to_upper_copy(pName);
852 853
                SolverInfoMap::const_iterator iter = m_solverInfo.find(vName);
                if(iter != m_solverInfo.end())
854 855 856 857 858 859 860 861
                {
                    return true;
                }
            }
            return false;
        }


862 863 864
        /**
         *
         */
865
        bool SessionReader::DefinesGlobalSysSolnInfo(const std::string &pVariable,
866 867 868
                                                     const std::string &pProperty) const
        {

869 870 871
            GloSysSolnInfoList::const_iterator iter =
                    GetGloSysSolnList().find(pVariable);
            if(iter == GetGloSysSolnList().end())
872 873 874 875 876
            {
                return false;
            }

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

878 879 880 881 882
            GloSysInfoMap::const_iterator iter1 = iter->second.find(vProperty);
            if(iter1 == iter->second.end())
            {
                return false;
            }
883

884 885 886
            return true;
        }

887

888 889 890 891 892
        /**
         *
         */
        const std::string &SessionReader::GetGlobalSysSolnInfo(const std::string &pVariable, const std::string &pProperty) const
        {
893
            GloSysSolnInfoList::const_iterator iter;
894

895 896
            ASSERTL0( (iter = GetGloSysSolnList().find(pVariable)) !=
                              GetGloSysSolnList().end(),
897 898 899
                      "Failed to find variable in GlobalSysSolnInfoList");

            std::string vProperty = boost::to_upper_copy(pProperty);
900
            GloSysInfoMap::const_iterator iter1;
901 902 903

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

905 906
            return iter1->second;
        }
907

908 909 910 911
        /**
         *
         */
        bool SessionReader::DefinesGeometricInfo(const std::string &pName) const
912 913
        {
            std::string vName = boost::to_upper_copy(pName);
914 915
            GeometricInfoMap::const_iterator iter = m_geometricInfo.find(vName);
            return (iter != m_geometricInfo.end());
916 917
        }

918 919 920 921

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

939 940 941 942

        /**
         *
         */
943 944 945 946
        void SessionReader::LoadGeometricInfo(
            const std::string &pName,
                  bool        &pVar,
            const bool        &pDefault) const
947 948
        {
            std::string vName = boost::to_upper_copy(pName);
949 950
            GeometricInfoMap::const_iterator iter = m_geometricInfo.find(vName);
            if(iter != m_geometricInfo.end())
951
            {
952
                if (iter->second == "TRUE")
953 954 955 956 957 958 959 960 961 962
                {
                    pVar = true;
                }
                else
                {
                    pVar = false;
                }
            }
            else
            {
963
                pVar = pDefault;
964 965 966
            }
        }

967

968 969 970
        /**
         *
         */
971 972 973 974
        void SessionReader::LoadGeometricInfo(
            const std::string &pName,
                  NekDouble   &pVar,
            const NekDouble   &pDefault) const
975 976
        {
            std::string vName = boost::to_upper_copy(pName);
977 978
            GeometricInfoMap::const_iterator iter = m_geometricInfo.find(vName);
            if(iter != m_geometricInfo.end())
979
            {
980
                pVar = std::atoi(iter->second.c_str());
981 982 983
            }
            else
            {
984
                pVar = pDefault;
985 986 987 988
            }
        }


989 990 991
        /**
         *
         */
992 993 994 995 996
        void SessionReader::MatchGeometricInfo(
            const std::string &pName,
            const std::string &pTrueVal,
                  bool        &pVar,
            const bool        &pDefault) const
997 998
        {
            std::string vName = boost::to_upper_copy(pName);
999 1000
            GeometricInfoMap::const_iterator iter = m_geometricInfo.find(vName);
            if(iter != m_geometricInfo.end())
1001
            {
1002
                pVar = boost::iequals(iter->second, pTrueVal);
1003 1004 1005 1006 1007 1008 1009 1010
            }
            else
            {
                pVar  = pDefault;
            }
        }


1011 1012 1013
        /**
         *
         */
1014 1015
        const std::string& SessionReader::GetVariable(
            const unsigned int &idx) const
1016 1017 1018 1019 1020
        {
            ASSERTL0(idx < m_variables.size(), "Variable index out of range.");
            return m_variables[idx];
        }

1021

1022 1023 1024 1025

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


1034 1035 1036
        /**
         *
         */
1037 1038 1039 1040 1041
        std::vector<std::string> SessionReader::GetVariables() const
        {
            return m_variables;
        }

1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061

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


        /**
         *
         */
1062 1063
        bool SessionReader::DefinesFunction(
            const std::string &pName,
1064 1065
            const std::string &pVariable,
            const int pDomain) const
1066 1067
        {
            FunctionMap::const_iterator it1;
1068
            FunctionVariableMap::const_iterator it2;
1069 1070
            std::string vName = boost::to_upper_copy(pName);

1071 1072
            // Check function exists
            if ((it1 = m_functions.find(vName))     != m_functions.end())
1073
            {
1074 1075
                pair<std::string, int> key(pVariable,pDomain);
                pair<std::string, int> defkey("*",pDomain);
1076
                bool varExists =
1077 1078
                    (it2 = it1->second.find(key)) != it1->second.end() ||
                    (it2 = it1->second.find(defkey)) != it1->second.end();
1079
                return varExists;
1080 1081 1082 1083 1084 1085 1086 1087
            }
            return false;
        }


        /**
         *
         */
1088 1089
        EquationSharedPtr SessionReader::GetFunction(
            const std::string &pName,
1090 1091
            const std::string &pVariable,
            const int pDomain) const
1092 1093
        {
            FunctionMap::const_iterator it1;
1094
            FunctionVariableMap::const_iterator it2, it3;
1095 1096 1097 1098 1099
            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."));
1100 1101

            // Check for specific and wildcard definitions
1102 1103 1104 1105 1106 1107
            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();
1108 1109 1110

            // Check function is defined somewhere
            ASSERTL0(specific || wildcard,
1111
                     "No such variable " + pVariable
1112
                     + " in domain " + boost::lexical_cast<string>(pDomain)
1113 1114
                     + " defined for function " + pName
                     + " in session file.");
1115 1116 1117 1118 1119 1120 1121

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

1122
            ASSERTL0((it2->second.m_type == eFunctionTypeExpression),
1123
                    std::string("Function is defined by a file."));
1124
            return it2->second.m_expression;
1125 1126
        }

1127 1128 1129 1130

        /**
         *
         */
1131 1132
        EquationSharedPtr SessionReader::GetFunction(
            const std::string  &pName,
1133 1134
            const unsigned int &pVar,
            const int pDomain) const
1135 1136
        {
            ASSERTL0(pVar < m_variables.size(), "Variable index out of range.");
1137
            return GetFunction(pName, m_variables[pVar],pDomain);
1138 1139
        }

1140 1141 1142 1143

        /**
         *
         */
1144 1145
        enum FunctionType SessionReader::GetFunctionType(
            const std::string &pName,
1146 1147
            const std::string &pVariable,
            const int pDomain) const
1148 1149
        {
            FunctionMap::const_iterator it1;
1150
            FunctionVariableMap::const_iterator it2, it3;
1151 1152 1153 1154 1155 1156
            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."));
1157 1158

            // Check for specific and wildcard definitions
1159 1160 1161
            pair<std::string,int> key(pVariable,pDomain);
            pair<std::string,int> defkey("*",pDomain);
            bool specific = (it2 = it1->second.find(key)) !=
1162
                            it1->second.end();
1163
            bool wildcard = (it3 = it1->second.find(defkey)) !=
1164 1165 1166 1167
                            it1->second.end();

            // Check function is defined somewhere
            ASSERTL0(specific || wildcard,
1168
                     "No such variable " + pVariable
1169
                     + " in domain " + boost::lexical_cast<string>(pDomain)
1170 1171
                     + " defined for function " + pName
                     + " in session file.");
1172 1173 1174 1175 1176 1177 1178

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

1179
            return it2->second.m_type;
1180 1181
        }

1182 1183 1184 1185

        /**
         *
         */
1186 1187
        enum FunctionType SessionReader::GetFunctionType(
            const std::string  &pName,
1188 1189
            const unsigned int &pVar,
            const int pDomain) const
1190 1191
        {
            ASSERTL0(pVar < m_variables.size(), "Variable index out of range.");
1192
            return GetFunctionType(pName, m_variables[pVar],pDomain);
1193 1194 1195 1196 1197 1198
        }


        /**
         *
         */
1199
        std::string SessionReader::GetFunctionFilename(
1200
            const std::string &pName,
1201 1202
            const std::string &pVariable,
            const int pDomain) const
1203 1204
        {
            FunctionMap::const_iterator it1;
1205
            FunctionVariableMap::const_iterator it2, it3;
1206 1207 1208 1209 1210 1211
            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."));
1212 1213

            // Check for specific and wildcard definitions
1214 1215 1216
            pair<std::string,int> key(pVariable,pDomain);
            pair<std::string,int> defkey("*",pDomain);
            bool specific = (it2 = it1->second.find(key)) !=
1217
                            it1->second.end();
1218
            bool wildcard = (it3 = it1->second.find(defkey)) !=
1219 1220 1221 1222
                            it1->second.end();

            // Check function is defined somewhere
            ASSERTL0(specific || wildcard,
1223
                     "No such variable " + pVariable
1224
                     + " in domain " + boost::lexical_cast<string>(pDomain)
1225 1226
                     + " defined for function " + pName
                     + " in session file.");
Chris Cantwell's avatar