libMesh::FEComputeData Class Reference

Helper class used with FEInterface::compute_data(). More...

#include <fe_compute_data.h>

Public Member Functions

 FEComputeData (const EquationSystems &es, const Point &pin)
 
void clear ()
 
void init ()
 

Public Attributes

const EquationSystemsequation_systems
 
const Pointp
 
std::vector< Numbershape
 
Real phase
 
Real speed
 
Number frequency
 

Detailed Description

Helper class used with FEInterface::compute_data().

class FEComputeData hides arbitrary data to be passed to and from children of FEBase through the FEInterface::compute_data() method. This enables the efficient computation of data on the finite element level, while maintaining library integrity.

  • With special finite elements disabled (like infinite elements), this class wraps the return values of all shape functions from FEInterface::shape() in a std::vector<Number>.
  • With infinite elements enabled, this class returns a vector of physically correct shape functions, both for finite and infinite elements.
Author
Daniel Dreyer
Date
2003

Definition at line 50 of file fe_compute_data.h.

Constructor & Destructor Documentation

libMesh::FEComputeData::FEComputeData ( const EquationSystems es,
const Point pin 
)
inline

Constructor. Takes the required input data and clears the output data using clear().

Definition at line 57 of file fe_compute_data.h.

References clear().

58  :
59  equation_systems(es),
60  p(pin)
61  {
62  this->clear();
63  }
const EquationSystems & equation_systems

Member Function Documentation

void libMesh::FEComputeData::clear ( )

Clears the output data completely.

Definition at line 25 of file fe_compute_data.C.

References frequency, phase, shape, and speed.

Referenced by FEComputeData().

26 {
27  this->shape.clear();
28 #if defined(LIBMESH_ENABLE_INFINITE_ELEMENTS) && !defined(LIBMESH_USE_COMPLEX_NUMBERS)
29  this->phase = 0.;
30  this->speed = 1.;
31 #endif
32 
33 #if defined (LIBMESH_ENABLE_INFINITE_ELEMENTS) && defined(LIBMESH_USE_COMPLEX_NUMBERS)
34  //lets default speed and frequency to 1; 0 leads to troubles with the wavenumber.
35  this->speed = 1.;
36  this->frequency = 1.;
37 
38 #endif
39 }
std::vector< Number > shape
void libMesh::FEComputeData::init ( )

Inits the output data to default values, provided the fields are correctly resized.

Definition at line 43 of file fe_compute_data.C.

References equation_systems, frequency, libMesh::Parameters::get(), libMesh::Parameters::have_parameter(), libMesh::EquationSystems::parameters, phase, libMesh::Real, shape, and speed.

Referenced by libMesh::FEInterface::compute_data().

44 {
45  if (!(this->shape.empty()))
46  std::fill (this->shape.begin(), this->shape.end(), 0.);
47 
48 #if defined(LIBMESH_ENABLE_INFINITE_ELEMENTS) && !defined(LIBMESH_USE_COMPLEX_NUMBERS)
49  this->phase = 0.;
50 
52  this->speed = this->equation_systems.parameters.get<Real>("speed");
53 #endif
54 
55 #if defined (LIBMESH_ENABLE_INFINITE_ELEMENTS) && defined(LIBMESH_USE_COMPLEX_NUMBERS)
57  this->speed = this->equation_systems.parameters.get<Real>("speed");
58 
59  if (equation_systems.parameters.have_parameter<Real>("current frequency"))
60  {
61  // please use the type Number instead.
62  libmesh_deprecated();
63  this->frequency = static_cast<Number> (this->equation_systems.parameters.get<Real>("current frequency"));
64  }
65 
66  else if (equation_systems.parameters.have_parameter<Number>("current frequency"))
67  this->frequency = this->equation_systems.parameters.get<Number>("current frequency");
68 
69 #endif
70  // ensure that the wavenumber k=2. * libMesh::pi * this->frequency / this->speed
71  // in src/fe/inf_fe_static.C: 310
72  // is well-defined. 0 as well as NaN will lead to problems here.
73 #if defined(LIBMESH_ENABLE_INFINITE_ELEMENTS) && defined(LIBMESH_USE_COMPLEX_NUMBERS)
74  libmesh_assert_not_equal_to(this->frequency, 0.);
75 #endif
76 #if defined(LIBMESH_ENABLE_INFINITE_ELEMENTS)
77  libmesh_assert_not_equal_to(this->speed, 0);
78 #endif
79 
80 }
const EquationSystems & equation_systems
const T & get(const std::string &) const
Definition: parameters.h:426
std::vector< Number > shape
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
bool have_parameter(const std::string &) const
Definition: parameters.h:407

Member Data Documentation

const EquationSystems& libMesh::FEComputeData::equation_systems

Const reference to the EquationSystems object that contains simulation-specific data.

Definition at line 69 of file fe_compute_data.h.

Referenced by init().

Number libMesh::FEComputeData::frequency

The frequency to evaluate shape functions including the wave number depending terms. Use imaginary contributions for exponential damping

Definition at line 102 of file fe_compute_data.h.

Referenced by clear(), libMesh::InfFE< Dim, T_radial, T_map >::compute_data(), and init().

const Point& libMesh::FEComputeData::p

Holds the point where the data are to be computed

Definition at line 74 of file fe_compute_data.h.

Referenced by libMesh::InfFE< Dim, T_radial, T_map >::compute_data(), and libMesh::FEInterface::compute_data().

Real libMesh::FEComputeData::phase

Storage for the computed phase lag

Definition at line 86 of file fe_compute_data.h.

Referenced by clear(), libMesh::InfFE< Dim, T_radial, T_map >::compute_data(), and init().

std::vector<Number> libMesh::FEComputeData::shape
Real libMesh::FEComputeData::speed

The wave speed.

Definition at line 93 of file fe_compute_data.h.

Referenced by clear(), libMesh::InfFE< Dim, T_radial, T_map >::compute_data(), and init().


The documentation for this class was generated from the following files: