CoupledFEMFunctionsy Class Reference

#include <coupled_system.h>

Inheritance diagram for CoupledFEMFunctionsy:

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

Private Attributes
unsigned int	var

Detailed Description

Definition at line 139 of file coupled_system.h.

Constructor & Destructor Documentation

CoupledFEMFunctionsy()

CoupledFEMFunctionsy::CoupledFEMFunctionsy ( System &  , unsigned int  var_number  )

inline

Definition at line 143 of file coupled_system.h.

  { var = var_number; }

References var.

~CoupledFEMFunctionsy()

virtual CoupledFEMFunctionsy::~CoupledFEMFunctionsy ( )

virtualdefault

Member Function Documentation

clone()

virtual std::unique_ptr< FEMFunctionBase< Number > > CoupledFEMFunctionsy::clone ( ) const

inlinevirtual

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 150 of file coupled_system.h.

  {
    return std::make_unique<CoupledFEMFunctionsy>(*this);
  }

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 129 of file fem_function_base.h.

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

init()

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

inlinevirtualinherited

Any post-construction initialization.

Definition at line 69 of file fem_function_base.h.

{}

init_context()

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

inlinevirtualinherited

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 SlitFunc.

Definition at line 77 of file fem_function_base.h.

{}

operator()() [1/3]

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

inlinevirtual

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.

Implements libMesh::FEMFunctionBase< Number >.

Definition at line 155 of file coupled_system.h.

  { libmesh_not_implemented(); }

operator()() [2/3]

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 >.

Definition at line 477 of file coupled_system.C.

{
  Number weight = 0.0;
 
  switch(var)
    {
    case 1:
      {
        Gradient grad_C = c.point_gradient(3, p);
 
        weight = grad_C(1);
      }
      break;
 
    case 3:
      {
        Number v = c.point_value(1, p);
 
        weight = v;
      }
      break;
 
    default:
      libmesh_error_msg("Wrong variable number "                        \
                        << var                                          \
                        << " passed to CoupledFEMFunctionsy object! Quitting!");
    }
 
  return weight;
}

References libMesh::FEMContext::point_gradient(), libMesh::FEMContext::point_value(), and var.

operator()() [3/3]

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 102 of file fem_function_base.h.

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

Member Data Documentation

var

unsigned int CoupledFEMFunctionsy::var

private

Definition at line 166 of file coupled_system.h.

Referenced by CoupledFEMFunctionsy(), and operator()().

---

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

• examples/adjoints/adjoints_ex3/coupled_system.h
• examples/adjoints/adjoints_ex3/coupled_system.C