libMesh
Public Member Functions | Public Attributes | Private 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...
 
void enable_derivative ()
 Enable the computation of shape gradients (dshape). More...
 
void disable_derivative ()
 Disable the computation of shape gradients (dshape). More...
 
bool need_derivative ()
 Check whether derivatives should be computed or not. 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...
 
std::vector< Gradientdshape
 Storage for the computed shape derivative values. More...
 
std::vector< std::vector< Real > > local_transform
 Storage for local to global mapping at p. 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...
 

Private Attributes

bool _need_dshape
 variable indicating whether the shape-derivative should be computed or not. 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 51 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 58 of file fe_compute_data.h.

References clear().

59  :
60  equation_systems(es),
61  p(pin),
62  _need_dshape(false)
63  {
64  this->clear();
65  }
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.
bool _need_dshape
variable indicating whether the shape-derivative should be computed or not.

Member Function Documentation

◆ clear()

void libMesh::FEComputeData::clear ( )

Clears the output data completely.

Referenced by FEComputeData().

◆ disable_derivative()

void libMesh::FEComputeData::disable_derivative ( )

Disable the computation of shape gradients (dshape).

Default is disabled.

Definition at line 137 of file fe_compute_data.h.

References _need_dshape.

138  {_need_dshape=false; }
bool _need_dshape
variable indicating whether the shape-derivative should be computed or not.

◆ enable_derivative()

void libMesh::FEComputeData::enable_derivative ( )

Enable the computation of shape gradients (dshape).

◆ init()

void libMesh::FEComputeData::init ( )

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

◆ need_derivative()

bool libMesh::FEComputeData::need_derivative ( )

Check whether derivatives should be computed or not.

Definition at line 143 of file fe_compute_data.h.

References _need_dshape.

144  {return _need_dshape; }
bool _need_dshape
variable indicating whether the shape-derivative should be computed or not.

Member Data Documentation

◆ _need_dshape

bool libMesh::FEComputeData::_need_dshape
private

variable indicating whether the shape-derivative should be computed or not.

Default is false to save time and be compatible with elements where derivatives are not implemented/ cannot be computed.

Definition at line 152 of file fe_compute_data.h.

Referenced by disable_derivative(), and need_derivative().

◆ dshape

std::vector<Gradient> libMesh::FEComputeData::dshape

Storage for the computed shape derivative values.

Definition at line 86 of file fe_compute_data.h.

◆ equation_systems

const EquationSystems& libMesh::FEComputeData::equation_systems

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

Definition at line 71 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 114 of file fe_compute_data.h.

◆ local_transform

std::vector<std::vector<Real> > libMesh::FEComputeData::local_transform

Storage for local to global mapping at p.

This is needed when the gradient in physical coordinates is of interest. FIXME: What kind of type should one use for it? The matrix-class don't look as if they were made for it and neither are the TensorTool-members.

Definition at line 96 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 76 of file fe_compute_data.h.

◆ phase

Real libMesh::FEComputeData::phase

Storage for the computed phase lag.

Definition at line 102 of file fe_compute_data.h.

◆ shape

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

Storage for the computed shape function values.

Definition at line 81 of file fe_compute_data.h.

◆ speed

Real libMesh::FEComputeData::speed

The wave speed.

Definition at line 107 of file fe_compute_data.h.


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