FEComputeData

NAME

SYNOPSIS

#include <fe_compute_data.h>  

Public Member Functions

FEComputeData (const EquationSystems &es, const Point &pin)

void clear ()

void init ()
 

Public Attributes

const EquationSystems & equation_systems

const Point & p

std::vector< Number > shape

Real phase

Real speed

Real frequency
 

Detailed Description

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 enabled infinite elements, this class returns a vector of physically correct shape functions, both for finite and infinite elements.

Definition at line 46 of file fe_compute_data.h.  

Constructor & Destructor Documentation

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().

                                   :
    equation_systems(es),
    p(pin)
  { 
    this->clear(); 
  }

Member Function Documentation

void 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().

{ 
  this->shape.clear();
#if defined(LIBMESH_ENABLE_INFINITE_ELEMENTS) && !defined(LIBMESH_USE_COMPLEX_NUMBERS)
  this->phase = 0.;
  this->speed = 0.;
#endif

#if defined (LIBMESH_ENABLE_INFINITE_ELEMENTS) && defined(LIBMESH_USE_COMPLEX_NUMBERS)
  this->speed = 0.;
  this->frequency = 0.;

#endif
}

void FEComputeData::init ()Inits the output data to default values, provided the fields are correctly resized.

Definition at line 42 of file fe_compute_data.C.

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

Referenced by FEInterface::compute_data().

{ 
  if (!(this->shape.empty()))
    std::fill (this->shape.begin(),   this->shape.end(),   0.);
  
#if defined(LIBMESH_ENABLE_INFINITE_ELEMENTS) && !defined(LIBMESH_USE_COMPLEX_NUMBERS)
  this->phase = 0.;

  if (equation_systems.parameters.have_parameter<Real>('speed'))
    this->speed = this->equation_systems.parameters.get<Real>('speed');
#endif

#if defined (LIBMESH_ENABLE_INFINITE_ELEMENTS) && defined(LIBMESH_USE_COMPLEX_NUMBERS)
  if (equation_systems.parameters.have_parameter<Real>('speed'))
    this->speed = this->equation_systems.parameters.get<Real>('speed');

  if (equation_systems.parameters.have_parameter<Real>('current frequency'))  
    this->frequency = this->equation_systems.parameters.get<Real>('current frequency');

#endif
}

Member Data Documentation

const EquationSystems& FEComputeData::equation_systemsConst reference to the EquationSystems object that contains simulation-specific data.

Definition at line 72 of file fe_compute_data.h.

Referenced by init().  

Real FEComputeData::frequencyThe frequency to evaluate shape functions including the wave number depending terms

Definition at line 109 of file fe_compute_data.h.

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

const Point& FEComputeData::pHolds the point where the data are to be computed

Definition at line 76 of file fe_compute_data.h.

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

Real FEComputeData::phaseStorage for the computed phase lag

Definition at line 92 of file fe_compute_data.h.

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

std::vector<Number> FEComputeData::shapeStorage for the computed shape function values.

Definition at line 85 of file fe_compute_data.h.

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

Real FEComputeData::speedThe wave speed.

Definition at line 100 of file fe_compute_data.h.

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

Author

Generated automatically by Doxygen for libMesh from the source code.

Index

NAME

SYNOPSIS

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

FEComputeData::FEComputeData (const EquationSystems &es, const Point &pin) [inline]Constructor. Takes the required input data and clears the output data using clear().

Member Function Documentation

void FEComputeData::clear ()Clears the output data completely.

void FEComputeData::init ()Inits the output data to default values, provided the fields are correctly resized.

Member Data Documentation

const EquationSystems& FEComputeData::equation_systemsConst reference to the EquationSystems object that contains simulation-specific data.

Real FEComputeData::frequencyThe frequency to evaluate shape functions including the wave number depending terms

const Point& FEComputeData::pHolds the point where the data are to be computed

Real FEComputeData::phaseStorage for the computed phase lag

std::vector<Number> FEComputeData::shapeStorage for the computed shape function values.

Real FEComputeData::speedThe wave speed.

Author