Nektar++
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Properties
Friends
Macros
Pages
solvers
CardiacEPSolver
Stimuli
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
// License for the specific language governing rights and limitations under
14
// Permission is hereby granted, free of charge, to any person obtaining a
15
// copy of this software and associated documentation files (the "Software"),
16
// to deal in the Software without restriction, including without limitation
17
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
18
// and/or sell copies of the Software, and to permit persons to whom the
19
// Software is furnished to do so, subject to the following conditions:
20
//
21
// The above copyright notice and this permission notice shall be included
22
// in all copies or substantial portions of the Software.
23
//
24
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30
// DEALINGS IN THE SOFTWARE.
31
//
32
// Description: Protocol base class.
33
//
34
///////////////////////////////////////////////////////////////////////////////
35
36
#include <
CardiacEPSolver/Stimuli/Protocol.h
>
37
38
namespace
Nektar
39
{
40
ProtocolFactory
&
GetProtocolFactory
()
41
{
42
typedef
Loki::SingletonHolder<
ProtocolFactory
,
43
Loki::CreateUsingNew,
44
Loki::NoDestroy > Type;
45
return
Type::Instance();
46
}
47
48
/**
49
* @class Protocol
50
*
51
* The Stimuli class and derived classes implement a range of stimuli.
52
* The stimulus contains input stimuli that can be applied throughout the
53
* domain, on specified regions determined by the derived classes of
54
* Stimulus, at specified frequencies determined by the derived classes of
55
* Protocol.
56
*/
57
58
/**
59
* Protocol base class constructor.
60
*/
61
Protocol::Protocol
(
const
LibUtilities::SessionReaderSharedPtr
& pSession,
62
const
TiXmlElement* pXml)
63
: m_session(pSession)
64
{
65
}
66
67
68
/**
69
* Initialise the protocol. Allocate workspace and variable storage.
70
*/
71
void
Protocol::Initialise
()
72
{
73
}
74
75
}
Nektar
<
Definition:
CoupledSolver.h:1
Nektar::Protocol::Initialise
void Initialise()
Initialise the protocol storage and set initial conditions.
Definition:
Protocol.cpp:71
Nektar::GetProtocolFactory
ProtocolFactory & GetProtocolFactory()
Definition:
Protocol.cpp:40
Nektar::Protocol::Protocol
Protocol(const LibUtilities::SessionReaderSharedPtr &pSession, const TiXmlElement *pXml)
Definition:
Protocol.cpp:61
Nektar::LibUtilities::SessionReaderSharedPtr
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition:
MeshPartition.h:51
Protocol.h
Nektar::ProtocolFactory
LibUtilities::NekFactory< std::string, Protocol, const LibUtilities::SessionReaderSharedPtr &, const TiXmlElement * > ProtocolFactory
Datatype of the NekFactory used to instantiate classes derived from the EquationSystem class...
Definition:
Protocol.h:54
Nektar::LibUtilities::NekFactory
Provides a generic Factory class.
Definition:
NekFactory.hpp:116
Generated on Sat Nov 25 2017 16:18:16 for Nektar++ by
1.8.8