Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | Friends | List of all members
Nektar::FilterElectrogram Class Reference

#include <FilterElectrogram.h>

Inheritance diagram for Nektar::FilterElectrogram:
Inheritance graph
[legend]
Collaboration diagram for Nektar::FilterElectrogram:
Collaboration graph
[legend]

Public Member Functions

 FilterElectrogram (const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
 Electrogram filter constructor. More...
 
virtual ~FilterElectrogram ()
 Electrogram filter destructor. More...
 
- Public Member Functions inherited from Nektar::SolverUtils::Filter
SOLVER_UTILS_EXPORT Filter (const LibUtilities::SessionReaderSharedPtr &pSession)
 
virtual SOLVER_UTILS_EXPORT ~Filter ()
 
SOLVER_UTILS_EXPORT void Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
 
SOLVER_UTILS_EXPORT void Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
 
SOLVER_UTILS_EXPORT void Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
 
SOLVER_UTILS_EXPORT bool IsTimeDependent ()
 

Static Public Member Functions

static SolverUtils::FilterSharedPtr create (const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
 Creates an instance of this class. More...
 

Static Public Attributes

static std::string className
 Name of the class. More...
 

Protected Member Functions

virtual void v_Initialise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
 Initialises the electrogram filter and open output file. More...
 
virtual void v_Update (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
 Compute extracellular potential at egm points at current time. More...
 
virtual void v_Finalise (const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
 Finalise the electrogram filter and close output file. More...
 
virtual bool v_IsTimeDependent ()
 Filter is time-dependent and should be called at each time-step. More...
 

Private Attributes

Array< OneD, Array< OneD,
NekDouble > > 
m_grad_R_x
 Gradient of the radius from each electrogram point in x-direction. More...
 
Array< OneD, Array< OneD,
NekDouble > > 
m_grad_R_y
 Gradient of the radius from each electrogram point in y-direction. More...
 
Array< OneD, Array< OneD,
NekDouble > > 
m_grad_R_z
 Gradient of the radius from each electrogram point in z-direction. More...
 
SpatialDomains::PointGeomVector m_electrogramPoints
 List of electrogram points. More...
 
unsigned int m_index
 Counts number of calls to update (number of timesteps) More...
 
unsigned int m_outputFrequency
 Number of timesteps between outputs. More...
 
std::string m_outputFile
 Filename to output electrogram data to. More...
 
std::ofstream m_outputStream
 Output file stream for electrogram data. More...
 
std::stringstream m_electrogramStream
 Point coordinate input string. More...
 

Friends

class MemoryManager< FilterElectrogram >
 

Additional Inherited Members

- Public Types inherited from Nektar::SolverUtils::Filter
typedef std::map< std::string,
std::string > 
ParamMap
 
- Protected Attributes inherited from Nektar::SolverUtils::Filter
LibUtilities::SessionReaderSharedPtr m_session
 

Detailed Description

Definition at line 45 of file FilterElectrogram.h.

Constructor & Destructor Documentation

Nektar::FilterElectrogram::FilterElectrogram ( const LibUtilities::SessionReaderSharedPtr pSession,
const ParamMap pParams 
)

Electrogram filter constructor.

Definition at line 52 of file FilterElectrogram.cpp.

References ASSERTL0, Nektar::LibUtilities::Equation::Evaluate(), m_electrogramStream, m_index, m_outputFile, m_outputFrequency, and Nektar::SolverUtils::Filter::m_session.

55  : Filter(pSession)
56 {
57  ParamMap::const_iterator it;
58 
59  // OutputFile
60  it = pParams.find("OutputFile");
61  if (it == pParams.end())
62  {
63  m_outputFile = m_session->GetSessionName();
64  }
65  else
66  {
67  ASSERTL0(it->second.length() > 0, "Missing parameter 'OutputFile'.");
68  m_outputFile = it->second;
69  }
70  if (!(m_outputFile.length() >= 4
71  && m_outputFile.substr(m_outputFile.length() - 4) == ".ecg"))
72  {
73  m_outputFile += ".ecg";
74  }
75 
76  // OutputFrequency
77  it = pParams.find("OutputFrequency");
78  if (it == pParams.end())
79  {
81  }
82  else
83  {
84  LibUtilities::Equation equ(m_session, it->second);
85  m_outputFrequency = floor(equ.Evaluate());
86  }
87 
88  // Points
89  it = pParams.find("Points");
90  ASSERTL0(it != pParams.end(), "Missing parameter 'Points'.");
91  m_electrogramStream.str(it->second);
92  m_index = 0;
93 }
unsigned int m_index
Counts number of calls to update (number of timesteps)
std::string m_outputFile
Filename to output electrogram data to.
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:198
std::stringstream m_electrogramStream
Point coordinate input string.
unsigned int m_outputFrequency
Number of timesteps between outputs.
SOLVER_UTILS_EXPORT Filter(const LibUtilities::SessionReaderSharedPtr &pSession)
Definition: Filter.cpp:52
LibUtilities::SessionReaderSharedPtr m_session
Definition: Filter.h:84
Nektar::FilterElectrogram::~FilterElectrogram ( )
virtual

Electrogram filter destructor.

Definition at line 99 of file FilterElectrogram.cpp.

100 {
101 
102 }

Member Function Documentation

static SolverUtils::FilterSharedPtr Nektar::FilterElectrogram::create ( const LibUtilities::SessionReaderSharedPtr pSession,
const ParamMap pParams 
)
inlinestatic

Creates an instance of this class.

Definition at line 51 of file FilterElectrogram.h.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), and CellMLToNektar.cellml_metadata::p.

53  {
55  ::AllocateSharedPtr(pSession, pParams);
56  return p;
57  }
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
boost::shared_ptr< Filter > FilterSharedPtr
A shared pointer to a Driver object.
Definition: Filter.h:50
void Nektar::FilterElectrogram::v_Finalise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
protectedvirtual

Finalise the electrogram filter and close output file.

Implements Nektar::SolverUtils::Filter.

Definition at line 272 of file FilterElectrogram.cpp.

References m_outputStream.

275 {
276  if (pFields[0]->GetComm()->GetRank() == 0)
277  {
278  m_outputStream.close();
279  }
280 }
std::ofstream m_outputStream
Output file stream for electrogram data.
void Nektar::FilterElectrogram::v_Initialise ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
protectedvirtual

Initialises the electrogram filter and open output file.

Implements Nektar::SolverUtils::Filter.

Definition at line 108 of file FilterElectrogram.cpp.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), ASSERTL0, m_electrogramPoints, m_electrogramStream, m_grad_R_x, m_grad_R_y, m_grad_R_z, m_index, m_outputFile, m_outputStream, Nektar::SolverUtils::Filter::m_session, npts, Vmath::Sadd(), Vmath::Sdiv(), v_Update(), Vmath::Vsqrt(), Vmath::Vvtvp(), and Vmath::Vvtvvtp().

111 {
113  "No history points in stream.");
114 
115  m_index = 0;
116  Array<OneD, NekDouble> gloCoord(3,0.0);
117  LibUtilities::CommSharedPtr vComm = pFields[0]->GetComm();
118 
119  // Read electrogram points
120  // Always use dim = 3 to allow electrode to be above surface
121  const int dim = 3;
122  int i = 0;
123 
124  while (!m_electrogramStream.fail())
125  {
126  m_electrogramStream >> gloCoord[0] >> gloCoord[1] >> gloCoord[2];
127  if (!m_electrogramStream.fail())
128  {
131  ::AllocateSharedPtr(dim, i, gloCoord[0],
132  gloCoord[1], gloCoord[2]);
133 
134  m_electrogramPoints.push_back(vert);
135  ++i;
136  }
137  }
138 
139  if (vComm->GetRank() == 0)
140  {
141  // Open output stream
142  m_outputStream.open(m_outputFile.c_str());
143  m_outputStream << "# Electrogram data for variables (:";
144 
145  for (i = 0; i < pFields.num_elements(); ++i)
146  {
147  m_outputStream << m_session->GetVariable(i) <<",";
148  }
149 
150  m_outputStream << ") at points:" << endl;
151 
152  for (i = 0; i < m_electrogramPoints.size(); ++i)
153  {
154  m_electrogramPoints[i]->GetCoords( gloCoord[0],
155  gloCoord[1],
156  gloCoord[2]);
157 
158  m_outputStream << "# \t" << i;
159  m_outputStream.width(8);
160  m_outputStream << gloCoord[0];
161  m_outputStream.width(8);
162  m_outputStream << gloCoord[1];
163  m_outputStream.width(8);
164  m_outputStream << gloCoord[2];
165  m_outputStream << endl;
166  }
167  }
168 
169  // Compute the distance function for each electrogram point
170  const unsigned int nq = pFields[0]->GetNpoints();
171  const unsigned int npts = m_electrogramPoints.size();
172  NekDouble px, py, pz;
173  m_grad_R_x = Array<OneD, Array<OneD, NekDouble> >(npts);
174  m_grad_R_y = Array<OneD, Array<OneD, NekDouble> >(npts);
175  m_grad_R_z = Array<OneD, Array<OneD, NekDouble> >(npts);
176 
177  Array<OneD, NekDouble> x(nq);
178  Array<OneD, NekDouble> y(nq);
179  Array<OneD, NekDouble> z(nq);
180 
181  Array<OneD, NekDouble> oneOverR(nq);
182  for (unsigned int i = 0; i < npts; ++i)
183  {
184  m_grad_R_x[i] = Array<OneD, NekDouble>(nq);
185  m_grad_R_y[i] = Array<OneD, NekDouble>(nq);
186  m_grad_R_z[i] = Array<OneD, NekDouble>(nq);
187 
188  // Compute 1/R
189  m_electrogramPoints[i]->GetCoords(px,py,pz);
190 
191  pFields[0]->GetCoords(x,y,z);
192 
193  Vmath::Sadd (nq, -px, x, 1, x, 1);
194  Vmath::Sadd (nq, -py, y, 1, y, 1);
195  Vmath::Sadd (nq, -pz, z, 1, z, 1);
196  Vmath::Vvtvvtp(nq, x, 1, x, 1, y, 1, y, 1, oneOverR, 1);
197  Vmath::Vvtvp (nq, z, 1, z, 1, oneOverR, 1, oneOverR, 1);
198  Vmath::Vsqrt (nq, oneOverR, 1, oneOverR, 1);
199  Vmath::Sdiv (nq, 1.0, oneOverR, 1, oneOverR, 1);
200 
201  // Compute grad 1/R
202  pFields[0]->PhysDeriv(oneOverR, m_grad_R_x[i], m_grad_R_y[i],
203  m_grad_R_z[i]);
204  }
205 
206  // Compute electrogram point for initial condition
207  v_Update(pFields, time);
208 }
unsigned int m_index
Counts number of calls to update (number of timesteps)
std::string m_outputFile
Filename to output electrogram data to.
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:198
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
void Vsqrt(int n, const T *x, const int incx, T *y, const int incy)
sqrt y = sqrt(x)
Definition: Vmath.cpp:408
Array< OneD, Array< OneD, NekDouble > > m_grad_R_y
Gradient of the radius from each electrogram point in y-direction.
std::stringstream m_electrogramStream
Point coordinate input string.
std::ofstream m_outputStream
Output file stream for electrogram data.
SpatialDomains::PointGeomVector m_electrogramPoints
List of electrogram points.
void Vvtvp(int n, const T *w, const int incw, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
vvtvp (vector times vector plus vector): z = w*x + y
Definition: Vmath.cpp:442
virtual void v_Update(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
Compute extracellular potential at egm points at current time.
void Sdiv(int n, const T alpha, const T *x, const int incx, T *y, const int incy)
Scalar multiply y = alpha/y.
Definition: Vmath.cpp:271
boost::shared_ptr< Comm > CommSharedPtr
Pointer to a Communicator object.
Definition: Comm.h:55
static std::string npts
Definition: InputFld.cpp:43
double NekDouble
void Sadd(int n, const T alpha, const T *x, const int incx, T *y, const int incy)
Add vector y = alpha + x.
Definition: Vmath.cpp:315
LibUtilities::SessionReaderSharedPtr m_session
Definition: Filter.h:84
void Vvtvvtp(int n, const T *v, int incv, const T *w, int incw, const T *x, int incx, const T *y, int incy, T *z, int incz)
vvtvvtp (vector times vector plus vector times vector):
Definition: Vmath.cpp:537
Array< OneD, Array< OneD, NekDouble > > m_grad_R_z
Gradient of the radius from each electrogram point in z-direction.
boost::shared_ptr< PointGeom > PointGeomSharedPtr
Definition: Geometry.h:60
Array< OneD, Array< OneD, NekDouble > > m_grad_R_x
Gradient of the radius from each electrogram point in x-direction.
bool Nektar::FilterElectrogram::v_IsTimeDependent ( )
protectedvirtual

Filter is time-dependent and should be called at each time-step.

Implements Nektar::SolverUtils::Filter.

Definition at line 286 of file FilterElectrogram.cpp.

287 {
288  return true;
289 }
void Nektar::FilterElectrogram::v_Update ( const Array< OneD, const MultiRegions::ExpListSharedPtr > &  pFields,
const NekDouble time 
)
protectedvirtual

Compute extracellular potential at egm points at current time.

Implements Nektar::SolverUtils::Filter.

Definition at line 214 of file FilterElectrogram.cpp.

References m_electrogramPoints, m_grad_R_x, m_grad_R_y, m_grad_R_z, m_index, m_outputFrequency, m_outputStream, Nektar::LibUtilities::ReduceSum, Vmath::Vvtvp(), and Vmath::Vvtvvtp().

Referenced by v_Initialise().

217 {
218  // Only output every m_outputFrequency.
219  if ((m_index++) % m_outputFrequency)
220  {
221  return;
222  }
223 
224  const unsigned int nq = pFields[0]->GetNpoints();
225  const unsigned int npoints = m_electrogramPoints.size();
226  LibUtilities::CommSharedPtr vComm = pFields[0]->GetComm();
227 
228  unsigned int i = 0;
229  Array<OneD, NekDouble> e(npoints);
230 
231  // Compute grad V
232  Array<OneD, NekDouble> grad_V_x(nq), grad_V_y(nq), grad_V_z(nq);
233  pFields[0]->PhysDeriv(pFields[0]->GetPhys(),
234  grad_V_x, grad_V_y, grad_V_z);
235 
236  for (i = 0; i < npoints; ++i)
237  {
238  // Multiply together
239  Array<OneD, NekDouble> output(nq);
240  Vmath::Vvtvvtp(nq, m_grad_R_x[i], 1, grad_V_x, 1, m_grad_R_y[i], 1,
241  grad_V_y, 1, output, 1);
242  Vmath::Vvtvp (nq, m_grad_R_z[i], 1, grad_V_z, 1, output, 1,
243  output, 1);
244 
245  e[i] = pFields[0]->Integral(output);
246  }
247 
248  // Exchange history data
249  // This could be improved to reduce communication but works for now
250  vComm->AllReduce(e, LibUtilities::ReduceSum);
251 
252  // Only the root process writes out electrogram data
253  if (vComm->GetRank() == 0)
254  {
255  m_outputStream.width(8);
256  m_outputStream << setprecision(6) << time;
257 
258  // Write data values point by point
259  for (i = 0; i < m_electrogramPoints.size(); ++i)
260  {
261  m_outputStream.width(25);
262  m_outputStream << setprecision(16) << e[i];
263  }
264  m_outputStream << endl;
265  }
266 }
unsigned int m_index
Counts number of calls to update (number of timesteps)
Array< OneD, Array< OneD, NekDouble > > m_grad_R_y
Gradient of the radius from each electrogram point in y-direction.
std::ofstream m_outputStream
Output file stream for electrogram data.
SpatialDomains::PointGeomVector m_electrogramPoints
List of electrogram points.
void Vvtvp(int n, const T *w, const int incw, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
vvtvp (vector times vector plus vector): z = w*x + y
Definition: Vmath.cpp:442
unsigned int m_outputFrequency
Number of timesteps between outputs.
boost::shared_ptr< Comm > CommSharedPtr
Pointer to a Communicator object.
Definition: Comm.h:55
void Vvtvvtp(int n, const T *v, int incv, const T *w, int incw, const T *x, int incx, const T *y, int incy, T *z, int incz)
vvtvvtp (vector times vector plus vector times vector):
Definition: Vmath.cpp:537
Array< OneD, Array< OneD, NekDouble > > m_grad_R_z
Gradient of the radius from each electrogram point in z-direction.
Array< OneD, Array< OneD, NekDouble > > m_grad_R_x
Gradient of the radius from each electrogram point in x-direction.

Friends And Related Function Documentation

friend class MemoryManager< FilterElectrogram >
friend

Definition at line 48 of file FilterElectrogram.h.

Member Data Documentation

std::string Nektar::FilterElectrogram::className
static
Initial value:

Name of the class.

Definition at line 60 of file FilterElectrogram.h.

SpatialDomains::PointGeomVector Nektar::FilterElectrogram::m_electrogramPoints
private

List of electrogram points.

Definition at line 94 of file FilterElectrogram.h.

Referenced by v_Initialise(), and v_Update().

std::stringstream Nektar::FilterElectrogram::m_electrogramStream
private

Point coordinate input string.

Definition at line 104 of file FilterElectrogram.h.

Referenced by FilterElectrogram(), and v_Initialise().

Array<OneD, Array<OneD, NekDouble> > Nektar::FilterElectrogram::m_grad_R_x
private

Gradient of the radius from each electrogram point in x-direction.

Definition at line 88 of file FilterElectrogram.h.

Referenced by v_Initialise(), and v_Update().

Array<OneD, Array<OneD, NekDouble> > Nektar::FilterElectrogram::m_grad_R_y
private

Gradient of the radius from each electrogram point in y-direction.

Definition at line 90 of file FilterElectrogram.h.

Referenced by v_Initialise(), and v_Update().

Array<OneD, Array<OneD, NekDouble> > Nektar::FilterElectrogram::m_grad_R_z
private

Gradient of the radius from each electrogram point in z-direction.

Definition at line 92 of file FilterElectrogram.h.

Referenced by v_Initialise(), and v_Update().

unsigned int Nektar::FilterElectrogram::m_index
private

Counts number of calls to update (number of timesteps)

Definition at line 96 of file FilterElectrogram.h.

Referenced by FilterElectrogram(), v_Initialise(), and v_Update().

std::string Nektar::FilterElectrogram::m_outputFile
private

Filename to output electrogram data to.

Definition at line 100 of file FilterElectrogram.h.

Referenced by FilterElectrogram(), and v_Initialise().

unsigned int Nektar::FilterElectrogram::m_outputFrequency
private

Number of timesteps between outputs.

Definition at line 98 of file FilterElectrogram.h.

Referenced by FilterElectrogram(), and v_Update().

std::ofstream Nektar::FilterElectrogram::m_outputStream
private

Output file stream for electrogram data.

Definition at line 102 of file FilterElectrogram.h.

Referenced by v_Finalise(), v_Initialise(), and v_Update().