SolutionHandle Class Reference

Provide a simple RAII interface for linear lagrange solution variables. More...

#include <SolutionHandle.h>

Public Member Functions
	SolutionHandle (const MooseVariableFieldBase &variable)
Number	operator() (const Node *node) const
	Get a value from the solution vector. More...
Number	old (const Node *node) const
	Get a value from the old solution vector. More...
void	set (const Node *node, Number val)
	Set a value in the solution vector. More...
Real	L2norm () const
void	close ()

Private Attributes
MooseVariableFieldBase &	_var
NumericVector< Number > &	_soln
const NumericVector< Number > &	_soln_old

Detailed Description

Provide a simple RAII interface for linear lagrange solution variables.

Definition at line 21 of file SolutionHandle.h.

Constructor & Destructor Documentation

SolutionHandle()

SolutionHandle::SolutionHandle ( const MooseVariableFieldBase &  variable )

inline

Definition at line 24 of file SolutionHandle.h.

    : _var(const_cast<MooseVariableFieldBase &>(variable)),
      _soln(_var.sys().solution()),
      _soln_old(_var.sys().solutionOld())
  {
  }

Member Function Documentation

close()

void SolutionHandle::close ( )

inline

Definition at line 63 of file SolutionHandle.h.

{ _soln.close(); }

L2norm()

Real SolutionHandle::L2norm ( ) const

inline

Definition at line 58 of file SolutionHandle.h.

  {
    return _var.sys().system().calculate_norm(_soln, _var.number(), DISCRETE_L2);
  }

old()

Number SolutionHandle::old ( const Node *  node ) const

inline

Get a value from the old solution vector.

Definition at line 43 of file SolutionHandle.h.

  {
    // The 0 assumes linear Lagrange (I think)
    dof_id_type dof = node->dof_number(_var.sys().number(), _var.number(), 0);
    return _soln_old(dof);
  }

operator()()

Number SolutionHandle::operator() ( const Node *  node ) const

inline

Get a value from the solution vector.

Definition at line 34 of file SolutionHandle.h.

  {
    // The 0 assumes linear Lagrange (I think)
    dof_id_type dof = node->dof_number(_var.sys().number(), _var.number(), 0);
    return _soln(dof);
  }

set()

void SolutionHandle::set ( const Node *  node, Number  val  )

inline

Set a value in the solution vector.

Definition at line 52 of file SolutionHandle.h.

  {
    dof_id_type dof = node->dof_number(_var.sys().number(), _var.number(), 0);
    _soln.set(dof, val);
  }

Member Data Documentation

_soln

NumericVector<Number>& SolutionHandle::_soln

private

Definition at line 67 of file SolutionHandle.h.

Referenced by close(), L2norm(), operator()(), and set().

_soln_old

const NumericVector<Number>& SolutionHandle::_soln_old

private

Definition at line 68 of file SolutionHandle.h.

Referenced by old().

_var

MooseVariableFieldBase& SolutionHandle::_var

private

Definition at line 66 of file SolutionHandle.h.

Referenced by L2norm(), old(), operator()(), and set().

---

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

• subchannel/include/base/SolutionHandle.h