DUNE-ACFEM (2.5.1)

Dune::ACFem::GridFunctionExpression< FunctionSpaceImp, ExpressionImp, ExpressionTag > Class Template Reference

A class providing some basic functionality common to all expressions. More...

#include <dune/acfem/functions/gridfunctionexpressionbase.hh>

+ Collaboration diagram for Dune::ACFem::GridFunctionExpression< FunctionSpaceImp, ExpressionImp, ExpressionTag >:

Public Types

typedef ExpressionImp ExpressionType
 The type of the underlying expression.
 

Public Member Functions

void setName (const std::string &newName)
 Supply a descriptive name for the function. More...
 
const std::string & name () const
 Return a descriptive name for the function. More...
 
const std::string & expressionName () const
 Return a lengthy descriptive name for the underlying algebraic expression.
 
const ExpressionTypeexpression () const
 Return a const reference to the underlying expression.
 
ExpressionTypeexpression ()
 Return a mutable reference to the underlying expression.
 
ExpressionType operator* () const
 Return a copy from of the underlying expression.
 

Detailed Description

template<class FunctionSpaceImp, class ExpressionImp, template< class > class ExpressionTag = ExpressionTemplate>
class Dune::ACFem::GridFunctionExpression< FunctionSpaceImp, ExpressionImp, ExpressionTag >

A class providing some basic functionality common to all expressions.

Member Function Documentation

◆ name()

template<class FunctionSpaceImp , class ExpressionImp , template< class > class ExpressionTag = ExpressionTemplate>
const std::string& Dune::ACFem::GridFunctionExpression< FunctionSpaceImp, ExpressionImp, ExpressionTag >::name ( ) const
inline

Return a descriptive name for the function.

If set by setName(), return that user-supplied name. Otherwise return a (lengthy) auto-generated name describing the underlying algebraic expression.

References Dune::ACFem::ExpressionTemplate< ExpressionImp >::expression().

◆ setName()

template<class FunctionSpaceImp , class ExpressionImp , template< class > class ExpressionTag = ExpressionTemplate>
void Dune::ACFem::GridFunctionExpression< FunctionSpaceImp, ExpressionImp, ExpressionTag >::setName ( const std::string &  newName)
inline

Supply a descriptive name for the function.

This name will also be stored in the VTK files. It should be a "valid variable name".


The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (Apr 18, 22:30, 2024)