libMesh
Public Member Functions | List of all members
SlitFunc Class Referenceabstract
Inheritance diagram for SlitFunc:
[legend]

Public Member Functions

 SlitFunc ()
 
 ~SlitFunc ()
 
virtual void init_context (const FEMContext &) override
 Prepares a context object for use. More...
 
virtual std::unique_ptr< FEMFunctionBase< Number > > clone () const override
 
virtual Number operator() (const FEMContext &c, const Point &p, const Real=0.) override
 
virtual void operator() (const FEMContext &c, const Point &p, const Real time, DenseVector< Number > &output) override
 
virtual void init ()
 Any post-construction initialization. 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.)
 

Detailed Description

Definition at line 21 of file slit_mesh_test.C.

Constructor & Destructor Documentation

◆ SlitFunc()

SlitFunc::SlitFunc ( )
inline

Definition at line 25 of file slit_mesh_test.C.

25 {}

◆ ~SlitFunc()

SlitFunc::~SlitFunc ( )
inline

Definition at line 27 of file slit_mesh_test.C.

27 {}

Member Function Documentation

◆ clone()

virtual std::unique_ptr<FEMFunctionBase<Number> > SlitFunc::clone ( ) const
inlineoverridevirtual
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 32 of file slit_mesh_test.C.

33  {
34  return std::make_unique<SlitFunc>();
35  }

◆ component()

Number libMesh::FEMFunctionBase< Number >::component ( const FEMContext context,
unsigned int  i,
const Point p,
Real  time = 0. 
)
inlinevirtualinherited
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 137 of file fem_function_base.h.

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

◆ init()

virtual void libMesh::FEMFunctionBase< Number >::init ( )
inlinevirtualinherited

Any post-construction initialization.

Definition at line 69 of file fem_function_base.h.

69 {}

◆ init_context()

virtual void SlitFunc::init_context ( const FEMContext )
inlineoverridevirtual

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 from libMesh::FEMFunctionBase< Number >.

Definition at line 29 of file slit_mesh_test.C.

29 {}

◆ operator()() [1/4]

virtual Number SlitFunc::operator() ( const FEMContext ,
const Point p,
const Real  time = 0. 
)
inlineoverridevirtual
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 >.

Definition at line 37 of file slit_mesh_test.C.

References libMesh::FEMContext::get_elem(), libMesh::Real, and libMesh::Elem::vertex_average().

40  {
41  using std::abs;
42 
43  const Real & x = p(0);
44  const Real & y = p(1);
45  const Point centroid = c.get_elem().vertex_average();
46  const Real sign = centroid(1)/std::abs(centroid(1));
47 
48  // For testing we want something discontinuous on the slit,
49  // continuous everywhere else, and bilinear on all coarse quads
50  return (abs(x) + abs(2-x) - 2*abs(1-x)) * (1-abs(y)) * sign;
51  }
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
A Point defines a location in LIBMESH_DIM dimensional Real space.
Definition: point.h:39

◆ operator()() [2/4]

virtual void SlitFunc::operator() ( const FEMContext c,
const Point p,
const Real  time,
DenseVector< Number > &  output 
)
inlineoverridevirtual

Definition at line 53 of file slit_mesh_test.C.

References libMesh::DenseVector< T >::size().

57  {
58  for (unsigned int i=0; i != output.size(); ++i)
59  output(i) = (*this)(c, p, time);
60  }
virtual unsigned int size() const override final
Definition: dense_vector.h:104

◆ operator()() [3/4]

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

Evaluation function for time-independent vector-valued functions.

Sets output values in the passed-in output DenseVector.

Definition at line 149 of file fem_function_base.h.

152 {
153  // Call the time-dependent function with t=0.
154  this->operator()(context, p, 0., output);
155 }
virtual Number operator()(const FEMContext &, const Point &p, const Real time=0.)=0

◆ operator()() [4/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.


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