Nektar++
FilterThresholdMin.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File FilterThresholdMin.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 drops below a threshold value.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERUTILS_FILTERS_FILTERTHRESHOLDMIN_H
37 #define NEKTAR_SOLVERUTILS_FILTERS_FILTERTHRESHOLDMIN_H
38 
40 
41 namespace Nektar
42 {
43 namespace SolverUtils
44 {
45 
46 class FilterThresholdMin : public Filter
47 {
48 public:
50 
51  /// Creates an instance of this class
54  const ParamMap &pParams)
55  {
56  FilterSharedPtr p =
58  pSession, pParams);
59  return p;
60  }
61 
62  /// Name of the class
63  static std::string className;
64 
67  const ParamMap &pParams);
69 
70 protected:
71  /// Initialises the filter.
72  SOLVER_UTILS_EXPORT virtual void v_Initialise(
74  const NekDouble &time);
75  /// For each point in domain test if solution is below threshold.
76  SOLVER_UTILS_EXPORT virtual void v_Update(
78  const NekDouble &time);
79  /// Finalise the filter and write out data.
80  SOLVER_UTILS_EXPORT virtual void v_Finalise(
82  const NekDouble &time);
83  /// Indicate that this filter is time dependent.
85 
86 private:
87  /// Storage for recording when each point in domain drops below threshold.
89  /// Time at which to start recording.
91  /// Value of threshold.
93  /// Variable on which to detect threshold
95  /// Initial value of storage.
97  /// File into which to write output data.
98  std::string m_outputFile;
99  /// FieldIO object for writing data.
101 };
102 
103 }
104 }
105 
106 #endif /* FILTERTHRESHOLDMAX_H_ */
NekDouble m_startTime
Time at which to start recording.
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
static std::string className
Name of the class.
virtual SOLVER_UTILS_EXPORT void v_Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
Initialises the filter.
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
static FilterSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
Creates an instance of this class.
virtual SOLVER_UTILS_EXPORT bool v_IsTimeDependent()
Indicate that this filter is time dependent.
NekDouble m_thresholdValue
Value of threshold.
boost::shared_ptr< Filter > FilterSharedPtr
A shared pointer to a Driver object.
Definition: Filter.h:50
int m_thresholdVar
Variable on which to detect threshold.
boost::shared_ptr< FieldIO > FieldIOSharedPtr
Definition: FieldIO.h:236
double NekDouble
NekDouble m_initialValue
Initial value of storage.
SOLVER_UTILS_EXPORT FilterThresholdMin(const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
std::map< std::string, std::string > ParamMap
Definition: Filter.h:67
std::string m_outputFile
File into which to write output data.
virtual SOLVER_UTILS_EXPORT ~FilterThresholdMin()
virtual SOLVER_UTILS_EXPORT void v_Update(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
For each point in domain test if solution is below threshold.
#define SOLVER_UTILS_EXPORT
LibUtilities::FieldIOSharedPtr m_fld
FieldIO object for writing data.
virtual SOLVER_UTILS_EXPORT void v_Finalise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
Finalise the filter and write out data.
Array< OneD, NekDouble > m_threshold
Storage for recording when each point in domain drops below threshold.