libMesh::FEMFunctionBase< Output > Class Template Reference

#include <fem_function_base.h>

Inheritance diagram for libMesh::FEMFunctionBase< Output >:

List of all members.

Public Member Functions
virtual	~FEMFunctionBase ()
virtual void	init_context (const FEMContext &)
virtual UniquePtr < FEMFunctionBase< Output > >	clone () const =0
virtual Output	operator() (const FEMContext &, const Point &p, const Real time=0.)=0
void	operator() (const FEMContext &, const Point &p, DenseVector< Output > &output)
virtual void	operator() (const FEMContext &, const Point &p, const Real time, DenseVector< Output > &output)=0
virtual Output	component (const FEMContext &, unsigned int i, const Point &p, Real time=0.)
Protected Member Functions
	FEMFunctionBase ()

---

Detailed Description

template<typename Output = Number>
class libMesh::FEMFunctionBase< Output >

Definition at line 45 of file fem_function_base.h.

---

Constructor & Destructor Documentation

template<typename Output = Number>

libMesh::FEMFunctionBase< Output >::FEMFunctionBase

(

)

[inline, protected]

Constructor.

Definition at line 52 of file fem_function_base.h.

{}

template<typename Output = Number>

virtual libMesh::FEMFunctionBase< Output >::~FEMFunctionBase

(

)

[inline, virtual]

Destructor.

Definition at line 59 of file fem_function_base.h.

{}

---

Member Function Documentation

template<typename Output = Number>

virtual UniquePtr<FEMFunctionBase<Output> > libMesh::FEMFunctionBase< Output >::clone

(

)

const [pure 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.

Implemented in libMesh::ParsedFEMFunction< Output >, libMesh::CompositeFEMFunction< Output >, and libMesh::ConstFEMFunction< Output >.

Referenced by libMesh::CompositeFEMFunction< Output >::attach_subfunction().

template<typename Output >

Output libMesh::FEMFunctionBase< Output >::component	(	const FEMContext &	context,
		unsigned int	i,
		const Point &	p,
		Real	time = 0.
	)		[inline, virtual]

Returns:

the vector component i at coordinate p and time time. Subclasses aren't required to overload this, since the default implementation is based on the full vector evaluation, which is often correct. Subclasses are recommended to overload this, since the default implementation is based on a vector evaluation, which is usually unnecessarily inefficient.

Reimplemented in libMesh::ParsedFEMFunction< Output >, and libMesh::CompositeFEMFunction< Output >.

Definition at line 126 of file fem_function_base.h.

Referenced by libMesh::System::project_vector().

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

template<typename Output = Number>

virtual void libMesh::FEMFunctionBase< Output >::init_context

(

const FEMContext &

)

[inline, virtual]

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.

Reimplemented in libMesh::ParsedFEMFunction< Output >.

Definition at line 68 of file fem_function_base.h.

{}

template<typename Output = Number>

virtual Output libMesh::FEMFunctionBase< Output >::operator()	(	const FEMContext &	,
		const Point &	p,
		const Real	time = 0.
	)		[pure virtual]

Returns:

the scalar value at coordinate p and time time, which defaults to zero. Purely virtual, so you have to overload it. Note that this cannot be a const method, check MeshFunction.

Implemented in libMesh::ParsedFEMFunction< Output >, libMesh::CompositeFEMFunction< Output >, and libMesh::ConstFEMFunction< Output >.

template<typename Output >

void libMesh::FEMFunctionBase< Output >::operator()	(	const FEMContext &	context,
		const Point &	p,
		DenseVector< Output > &	output
	)		[inline]

Return function for vectors. Returns in output the values of the data at the coordinate p.

Definition at line 137 of file fem_function_base.h.

{
  // Call the time-dependent function with t=0.
  this->operator()(context, p, 0., output);
}

template<typename Output = Number>

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

Return function for vectors. Returns in output the values of the data at the coordinate p and for time time. Purely virtual, so you have to overload it. Note that this cannot be a const method, check MeshFunction.

Implemented in libMesh::ParsedFEMFunction< Output >, libMesh::CompositeFEMFunction< Output >, and libMesh::ConstFEMFunction< Output >.

---

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

• fem_function_base.h