libMesh
Public Member Functions | Private Attributes | List of all members
CoupledFEMFunctionsy Class Referenceabstract

#include <coupled_system.h>

Inheritance diagram for CoupledFEMFunctionsy:
[legend]

Public Member Functions

 CoupledFEMFunctionsy (System &, unsigned int var_number)
 
virtual ~CoupledFEMFunctionsy ()
 
virtual std::unique_ptr< FEMFunctionBase< Number > > clone () const
 
virtual void operator() (const FEMContext &, const Point &, const Real, DenseVector< Number > &)
 
virtual Number operator() (const FEMContext &, const Point &p, const Real time=0.)
 
virtual void init_context (const FEMContext &)
 Prepares a context object for use. More...
 
void operator() (const FEMContext &, const Point &p, DenseVector< Number > &output)
 Evaluation function for time-independent vector-valued functions. More...
 
virtual void operator() (const FEMContext &, const Point &p, const Real time, DenseVector< Number > &output)=0
 Evaluation function for time-dependent vector-valued functions. More...
 
virtual Number component (const FEMContext &, unsigned int i, const Point &p, Real time=0.)
 

Private Attributes

unsigned int var
 

Detailed Description

Definition at line 138 of file coupled_system.h.

Constructor & Destructor Documentation

◆ CoupledFEMFunctionsy()

CoupledFEMFunctionsy::CoupledFEMFunctionsy ( System ,
unsigned int  var_number 
)

Definition at line 142 of file coupled_system.h.

144  { var = var_number; }

◆ ~CoupledFEMFunctionsy()

virtual CoupledFEMFunctionsy::~CoupledFEMFunctionsy ( )
virtual

Definition at line 147 of file coupled_system.h.

147 {}

Member Function Documentation

◆ clone()

virtual std::unique_ptr<FEMFunctionBase<Number> > CoupledFEMFunctionsy::clone ( ) const
virtual
Returns
A new copy of the function.

The new copy should be as "deep" as necessary to allow independent destruction and simultaneous evaluations of the copies in different threads.

Implements libMesh::FEMFunctionBase< Number >.

Definition at line 149 of file coupled_system.h.

150  {
151  return libmesh_make_unique<CoupledFEMFunctionsy>(*this);
152  }

◆ component()

Number libMesh::FEMFunctionBase< Number >::component ( const FEMContext context,
unsigned int  i,
const Point p,
Real  time = 0. 
)
virtualinherited
Returns
The vector component i at coordinate p and time time.
Note
Subclasses aren't required to override this, since the default implementation is based on the full vector evaluation, which is often correct.
Subclasses are recommended to override this, since the default implementation is based on a vector evaluation, which is usually unnecessarily inefficient.

Definition at line 133 of file fem_function_base.h.

137 {
138  DenseVector<Output> outvec(i+1);
139  (*this)(context, p, time, outvec);
140  return outvec(i);
141 }

◆ init_context()

virtual void libMesh::FEMFunctionBase< Number >::init_context ( const FEMContext )
virtualinherited

Prepares a context object for use.

Most problems will want to reimplement this for efficiency, in order to call FE::get_*() as their particular function requires.

Definition at line 73 of file fem_function_base.h.

73 {}

◆ operator()() [1/4]

void libMesh::FEMFunctionBase< Number >::operator() ( const FEMContext context,
const Point p,
DenseVector< Number > &  output 
)
inherited

Evaluation function for time-independent vector-valued functions.

Sets output values in the passed-in output DenseVector.

Definition at line 145 of file fem_function_base.h.

148 {
149  // Call the time-dependent function with t=0.
150  this->operator()(context, p, 0., output);
151 }
virtual Number operator()(const FEMContext &, const Point &p, const Real time=0.)=0

◆ operator()() [2/4]

virtual void libMesh::FEMFunctionBase< Number >::operator() ( const FEMContext ,
const Point p,
const Real  time,
DenseVector< Number > &  output 
)
pure virtualinherited

Evaluation function for time-dependent vector-valued functions.

Sets output values in the passed-in output DenseVector.

Pure virtual, so you have to override it.

◆ operator()() [3/4]

virtual void CoupledFEMFunctionsy::operator() ( const FEMContext ,
const Point ,
const Real  ,
DenseVector< Number > &   
)
virtual

Definition at line 154 of file coupled_system.h.

158  { libmesh_not_implemented(); }

◆ operator()() [4/4]

virtual Number CoupledFEMFunctionsy::operator() ( const FEMContext ,
const Point p,
const Real  time = 0. 
)
virtual
Returns
The scalar function value at coordinate p and time time, which defaults to zero.

Pure virtual, so you have to override it.

Implements libMesh::FEMFunctionBase< Number >.

Member Data Documentation

◆ var

unsigned int CoupledFEMFunctionsy::var
private

Definition at line 165 of file coupled_system.h.


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