NuTo
Numerics Tool
Public Member Functions | List of all members
NuTo::Constraint::Equation Class Reference

stores a constraint equation More...

#include <Equation.h>

Public Member Functions

 Equation (const NodeSimple &dependentNode, int dependentComponent, RhsFunction rhs)
 ctor with constant rhs, defaults to 0 More...
 
void AddIndependentTerm (Term term)
 adds a term to the equation More...
 
double GetRhs (double time) const
 evaluates the rhs function at a given time More...
 
const TermGetDependentTerm () const
 getter for mTerms More...
 
const std::vector< Term > & GetIndependentTerms () const
 getter for mTerms More...
 
int GetDependentDofNumber () const
 

Detailed Description

stores a constraint equation

Constructor & Destructor Documentation

NuTo::Constraint::Equation::Equation ( const NodeSimple dependentNode,
int  dependentComponent,
RhsFunction  rhs 
)
inline

ctor with constant rhs, defaults to 0

Parameters
dependentNodenode reference
dependentComponentcomponent in the dof vector of the node
rhsvalue for the constant rhs

Member Function Documentation

void NuTo::Constraint::Equation::AddIndependentTerm ( Term  term)
inline

adds a term to the equation

Parameters
termequation term
int NuTo::Constraint::Equation::GetDependentDofNumber ( ) const
inline
const Term& NuTo::Constraint::Equation::GetDependentTerm ( ) const
inline

getter for mTerms

const std::vector<Term>& NuTo::Constraint::Equation::GetIndependentTerms ( ) const
inline

getter for mTerms

double NuTo::Constraint::Equation::GetRhs ( double  time) const
inline

evaluates the rhs function at a given time

Parameters
timeglobal time
Returns
rhs(time)

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