BdyFunction Class Reference

Inheritance diagram for BdyFunction:

Public Member Functions
	BdyFunction (unsigned int u_var, unsigned int v_var, int sign)
virtual Number	operator() (const Point &, const Real=0)
virtual void	operator() (const Point &p, const Real, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions.
virtual std::unique_ptr< FunctionBase< Number > >	clone () const
	BdyFunction (unsigned int T_var)
virtual Number	operator() (const Point &, const Real=0)
virtual void	operator() (const Point &p, const Real, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions.
virtual std::unique_ptr< FunctionBase< Number > >	clone () const
	BdyFunction (unsigned int u_var, unsigned int v_var, unsigned int w_var, Real Reynolds)
virtual Number	operator() (const Point &, const Real=0)
virtual void	operator() (const Point &p, const Real, DenseVector< Number > &output)
	Evaluation function for time-dependent vector-valued functions.
virtual std::unique_ptr< FunctionBase< Number > >	clone () const
virtual void	init ()
	The actual initialization process.
virtual void	clear ()
	Clears the function.
void	operator() (const Point &p, DenseVector< Number > &output)
	Evaluation function for time-independent vector-valued functions.
virtual Number	component (unsigned int i, const Point &p, Real time=0.)
bool	initialized () const
void	set_is_time_dependent (bool is_time_dependent)
	Function to set whether this is a time-dependent function or not.
bool	is_time_dependent () const

Protected Attributes
const FunctionBase *	_master
	Const pointer to our master, initialized to nullptr.
bool	_initialized
	When init() was called so that everything is ready for calls to operator() (...), then this bool is true.
bool	_is_time_dependent
	Cache whether or not this function is actually time-dependent.

Private Attributes
const unsigned int	_u_var
const unsigned int	_v_var
const Real	_sign
const unsigned int	_T_var
const unsigned int	_w_var
const Real	_Re

Detailed Description

Definition at line 43 of file coupled_system.C.

Constructor & Destructor Documentation

BdyFunction() [1/3]

BdyFunction::BdyFunction ( unsigned int  u_var, unsigned int  v_var, int  sign  )

inline

Definition at line 46 of file coupled_system.C.

                         :
    _u_var(u_var),
    _v_var(v_var),
    _sign(sign)
  { this->_initialized = true; }

References libMesh::FunctionBase< Number >::_initialized.

BdyFunction() [2/3]

BdyFunction::BdyFunction ( unsigned int  T_var )

inline

Definition at line 33 of file poisson.C.

    : _T_var(T_var)
  { this->_initialized = true; }

References libMesh::FunctionBase< Number >::_initialized.

BdyFunction() [3/3]

BdyFunction::BdyFunction ( unsigned int  u_var, unsigned int  v_var, unsigned int  w_var, Real  Reynolds  )

inline

Definition at line 47 of file naviersystem.C.

    : _u_var(u_var), _v_var(v_var), _w_var(w_var), _Re(Reynolds)
  { this->_initialized = true; }

References libMesh::FunctionBase< Number >::_initialized.

Member Function Documentation

clear()

virtual void libMesh::FunctionBase< Number >::clear ( )

inlinevirtualinherited

Clears the function.

Reimplemented in ExampleOneFunction, ExampleOneFunction, libMesh::MeshfreeInterpolationFunction, and libMesh::MeshFunction.

Definition at line 92 of file function_base.h.

{}

clone() [1/3]

virtual std::unique_ptr< FunctionBase< Number > > BdyFunction::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::FunctionBase< Number >.

Definition at line 70 of file coupled_system.C.

  { return std::make_unique<BdyFunction>(_u_var, _v_var, int(_sign)); }

References _sign, _u_var, and _v_var.

clone() [2/3]

virtual std::unique_ptr< FunctionBase< Number > > BdyFunction::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::FunctionBase< Number >.

Definition at line 51 of file poisson.C.

  { return std::make_unique<BdyFunction>(_T_var); }

References _T_var.

clone() [3/3]

virtual std::unique_ptr< FunctionBase< Number > > BdyFunction::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::FunctionBase< Number >.

Definition at line 68 of file naviersystem.C.

  { return std::make_unique<BdyFunction>(_u_var, _v_var, _w_var, _Re); }

References _Re, _u_var, _v_var, and _w_var.

component()

Number libMesh::FunctionBase< Number >::component ( 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.

The default implementation calls operator() with a DenseVector of size i+1 which will result in unexpected behaviour if operator() makes any access beyond that limit.

Reimplemented in SolutionFunction< dim >, SolutionFunction< dim >, SolutionFunction< dim >, SolutionFunction< dim >, SolutionFunction< dim >, SolutionFunction< dim >, SolutionFunction< dim >, PeriodicQuadFunction, and TripleFunction.

Definition at line 145 of file function_base.h.

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

init()

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

inlinevirtualinherited

The actual initialization process.

Reimplemented in ExampleOneFunction, ExampleOneFunction, libMesh::MeshfreeInterpolationFunction, and libMesh::MeshFunction.

Definition at line 87 of file function_base.h.

{}

initialized()

bool libMesh::FunctionBase< Number >::initialized ( ) const

inlineinherited

Returns

true when this object is properly initialized and ready for use, false otherwise.

Definition at line 154 of file function_base.h.

{
  return (this->_initialized);
}

is_time_dependent()

bool libMesh::FunctionBase< Number >::is_time_dependent ( ) const

inlineinherited

Returns

true when the function this object represents is actually time-dependent, false otherwise.

Definition at line 168 of file function_base.h.

{
  return (this->_is_time_dependent);
}

operator()() [1/7]

virtual Number BdyFunction::operator() ( const Point &  p, const Real  time = 0  )

inlinevirtual

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::FunctionBase< Number >.

Definition at line 54 of file coupled_system.C.

  { libmesh_not_implemented(); }

operator()() [2/7]

virtual Number BdyFunction::operator() ( const Point &  p, const Real  time = 0  )

inlinevirtual

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::FunctionBase< Number >.

Definition at line 37 of file poisson.C.

  { libmesh_not_implemented(); }

operator()() [3/7]

virtual Number BdyFunction::operator() ( const Point &  p, const Real  time = 0  )

inlinevirtual

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::FunctionBase< Number >.

Definition at line 54 of file naviersystem.C.

  { libmesh_not_implemented(); }

operator()() [4/7]

virtual void BdyFunction::operator() ( 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::FunctionBase< Number >.

Definition at line 58 of file coupled_system.C.

  {
    output.resize(2);
    output.zero();
    const Real y=p(1);
    // Set the parabolic inflow boundary conditions at stations 0 & 1
    output(_u_var) = (_sign)*((y-2) * (y-3));
    output(_v_var) = 0;
  }

References _sign, _u_var, _v_var, libMesh::Real, libMesh::DenseVector< T >::resize(), and libMesh::DenseVector< T >::zero().

operator()() [5/7]

virtual void BdyFunction::operator() ( 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::FunctionBase< Number >.

Definition at line 40 of file poisson.C.

  {
    output.resize(2);
    output.zero();
    const Real x=p(0);
    // Set the parabolic weighting
    output(_T_var) = -x * (1 - x);
  }

References _T_var, libMesh::Real, libMesh::DenseVector< T >::resize(), and libMesh::DenseVector< T >::zero().

operator()() [6/7]

virtual void BdyFunction::operator() ( 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::FunctionBase< Number >.

Definition at line 57 of file naviersystem.C.

  {
    output.zero();
    const Real x=p(0), y=p(1), z=p(2);
    output(_u_var) = (_Re+1)*(y*y + z*z);
    output(_v_var) = (_Re+1)*(x*x + z*z);
    output(_w_var) = (_Re+1)*(x*x + y*y);
  }

References _Re, _u_var, _v_var, _w_var, libMesh::Real, and libMesh::DenseVector< T >::zero().

operator()() [7/7]

void libMesh::FunctionBase< Number >::operator() ( 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 116 of file function_base.h.

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

set_is_time_dependent()

void libMesh::FunctionBase< Number >::set_is_time_dependent ( bool  is_time_dependent )

inlineinherited

Function to set whether this is a time-dependent function or not.

This is intended to be only used by subclasses who cannot natively determine time-dependence. In such a case, this function should be used immediately following construction.

Definition at line 162 of file function_base.h.

{
  this->_is_time_dependent = is_time_dependent;
}

Member Data Documentation

_initialized

bool libMesh::FunctionBase< Number >::_initialized

protectedinherited

When init() was called so that everything is ready for calls to operator() (...), then this bool is true.

Definition at line 184 of file function_base.h.

_is_time_dependent

bool libMesh::FunctionBase< Number >::_is_time_dependent

protectedinherited

Cache whether or not this function is actually time-dependent.

Definition at line 189 of file function_base.h.

_master

const FunctionBase* libMesh::FunctionBase< Number >::_master

protectedinherited

Const pointer to our master, initialized to nullptr.

There may be cases where multiple functions are required, but to save memory, one master handles some centralized data.

Definition at line 178 of file function_base.h.

_Re

const Real BdyFunction::_Re

private

Definition at line 73 of file naviersystem.C.

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

_sign

const Real BdyFunction::_sign

private

Definition at line 75 of file coupled_system.C.

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

_T_var

const unsigned int BdyFunction::_T_var

private

Definition at line 55 of file poisson.C.

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

_u_var

const unsigned int BdyFunction::_u_var

private

Definition at line 74 of file coupled_system.C.

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

_v_var

const unsigned int BdyFunction::_v_var

private

Definition at line 74 of file coupled_system.C.

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

_w_var

const unsigned int BdyFunction::_w_var

private

Definition at line 72 of file naviersystem.C.

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

---

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

• examples/adjoints/adjoints_ex3/coupled_system.C
• examples/adjoints/adjoints_ex6/poisson.C
• examples/fem_system/fem_system_ex1/naviersystem.C