libMesh
Public Member Functions | Public Attributes | List of all members
libMesh::FEComputeData Class Reference

class FEComputeData hides arbitrary data to be passed to and from children of FEBase through the FEInterface::compute_data() method. More...

#include <fe_compute_data.h>

Public Member Functions

 FEComputeData (const EquationSystems &es, const Point &pin)
 Constructor. More...
 
void clear ()
 Clears the output data completely. More...
 
void init ()
 Inits the output data to default values, provided the fields are correctly resized. More...
 

Public Attributes

const EquationSystemsequation_systems
 Const reference to the EquationSystems object that contains simulation-specific data. More...
 
const Pointp
 Holds the point where the data are to be computed. More...
 
std::vector< Numbershape
 Storage for the computed shape function values. More...
 
Real phase
 Storage for the computed phase lag. More...
 
Real speed
 The wave speed. More...
 
Number frequency
 The frequency to evaluate shape functions including the wave number depending terms. More...
 

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.

Author
Daniel Dreyer
Date
2003 Helper class used with FEInterface::compute_data().

Definition at line 50 of file fe_compute_data.h.

Constructor & Destructor Documentation

◆ FEComputeData()

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

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
Const reference to the EquationSystems object that contains simulation-specific data.
const Point & p
Holds the point where the data are to be computed.
void clear()
Clears the output data completely.

Member Function Documentation

◆ clear()

void libMesh::FEComputeData::clear ( )

Clears the output data completely.

Referenced by FEComputeData().

◆ init()

void libMesh::FEComputeData::init ( )

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

Member Data Documentation

◆ equation_systems

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.

◆ frequency

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.

◆ p

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.

◆ phase

Real libMesh::FEComputeData::phase

Storage for the computed phase lag.

Definition at line 86 of file fe_compute_data.h.

◆ shape

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

Storage for the computed shape function values.

Definition at line 79 of file fe_compute_data.h.

◆ speed

Real libMesh::FEComputeData::speed

The wave speed.

Definition at line 93 of file fe_compute_data.h.


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