Nektar++
Protocol.cpp
Go to the documentation of this file.
1///////////////////////////////////////////////////////////////////////////////
2//
3// File: Protocol.cpp
4//
5// For more information, please see: http://www.nektar.info
6//
7// The MIT License
8//
9// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10// Department of Aeronautics, Imperial College London (UK), and Scientific
11// Computing and Imaging Institute, University of Utah (USA).
12//
13// Permission is hereby granted, free of charge, to any person obtaining a
14// copy of this software and associated documentation files (the "Software"),
15// to deal in the Software without restriction, including without limitation
16// the rights to use, copy, modify, merge, publish, distribute, sublicense,
17// and/or sell copies of the Software, and to permit persons to whom the
18// Software is furnished to do so, subject to the following conditions:
19//
20// The above copyright notice and this permission notice shall be included
21// in all copies or substantial portions of the Software.
22//
23// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29// DEALINGS IN THE SOFTWARE.
30//
31// Description: Protocol base class.
32//
33///////////////////////////////////////////////////////////////////////////////
34
36
37namespace Nektar
38{
40{
41 static ProtocolFactory instance;
42 return instance;
43}
44
45/**
46 * @class Protocol
47 *
48 * The Stimuli class and derived classes implement a range of stimuli.
49 * The stimulus contains input stimuli that can be applied throughout the
50 * domain, on specified regions determined by the derived classes of
51 * Stimulus, at specified frequencies determined by the derived classes of
52 * Protocol.
53 */
54
55/**
56 * Protocol base class constructor.
57 */
59 [[maybe_unused]] const TiXmlElement *pXml)
60 : m_session(pSession)
61{
62}
63
64/**
65 * Initialise the protocol. Allocate workspace and variable storage.
66 */
68{
69}
70
71} // namespace Nektar
Provides a generic Factory class.
void Initialise()
Initialise the protocol storage and set initial conditions.
Definition: Protocol.cpp:67
Protocol(const LibUtilities::SessionReaderSharedPtr &pSession, const TiXmlElement *pXml)
Definition: Protocol.cpp:58
std::shared_ptr< SessionReader > SessionReaderSharedPtr
ProtocolFactory & GetProtocolFactory()
Definition: Protocol.cpp:39