Nektar++
FilterBenchmark.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File FilterBenchmark.h
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: Outputs time when solution first exceeds a threshold value.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERUTILS_FILTERS_FILTERBENCHMARK_H
37 #define NEKTAR_SOLVERUTILS_FILTERS_FILTERBENCHMARK_H
38 
40 
41 namespace Nektar
42 {
43 
44 /// Records activation and repolarisation times
46 {
47 public:
49 
50  /// Creates an instance of this class
53  const ParamMap &pParams) {
56  pParams);
57  return p;
58  }
59 
60  /// Name of the class.
61  static std::string className;
62 
63  /// Construct the benchmark filter.
66  const ParamMap &pParams);
67 
68  /// Destructor for the benchmark filter.
69  virtual ~FilterBenchmark();
70 
71 protected:
72  /// Initialises the benchmark filter and allocates storage.
73  virtual void v_Initialise(
75  const NekDouble &time);
76  /// Update recorded times.
77  virtual void v_Update(
79  const NekDouble &time);
80  /// Finalises the benchmark filter and write out recorded data.
81  virtual void v_Finalise(
83  const NekDouble &time);
84  /// Identifies that the benchmark filter is time dependent.
85  virtual bool v_IsTimeDependent();
86 
87 private:
88  /// Storage for activation and repolarisation times.
89  std::vector<Array<OneD, NekDouble> > m_threshold;
90  /// Number of activations and repolarisations detected for each point.
92  /// Indicates if the previous event was an activation or repolarisation.
94  /// Time at which to start detecting activations and repolarisations.
96  /// Value at which tissue is considered active.
98  /// Initial time to use in storage array.
100  /// Filename of output files.
101  std::string m_outputFile;
102  /// FieldIO object used for writing output files.
104 };
105 
106 }
107 
108 #endif /* FILTERTHRESHOLDMAX_H_ */
virtual void v_Update(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
Update recorded times.
virtual ~FilterBenchmark()
Destructor for the benchmark filter.
NekDouble m_initialValue
Initial time to use in storage array.
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
virtual bool v_IsTimeDependent()
Identifies that the benchmark filter is time dependent.
std::string m_outputFile
Filename of output files.
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
Records activation and repolarisation times.
boost::shared_ptr< Filter > FilterSharedPtr
A shared pointer to a Driver object.
Definition: Filter.h:50
NekDouble m_startTime
Time at which to start detecting activations and repolarisations.
boost::shared_ptr< FieldIO > FieldIOSharedPtr
Definition: FieldIO.h:236
virtual void v_Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
Initialises the benchmark filter and allocates storage.
double NekDouble
LibUtilities::FieldIOSharedPtr m_fld
FieldIO object used for writing output files.
NekDouble m_thresholdValue
Value at which tissue is considered active.
std::map< std::string, std::string > ParamMap
Definition: Filter.h:67
std::vector< Array< OneD, NekDouble > > m_threshold
Storage for activation and repolarisation times.
Array< OneD, int > m_idx
Number of activations and repolarisations detected for each point.
static std::string className
Name of the class.
virtual void v_Finalise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
Finalises the benchmark filter and write out recorded data.
Array< OneD, int > m_polarity
Indicates if the previous event was an activation or repolarisation.
static SolverUtils::FilterSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
Creates an instance of this class.
FilterBenchmark(const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
Construct the benchmark filter.