This creates the base class for functions that have a saptial and temporal dependence, and provide sensitivity operations with respect to the functions and parameters. More...

#include <eigenproblem_assembly_elem_operations.h>

Inheritance diagram for MAST::FieldFunction< ValType >:

[legend]

Collaboration diagram for MAST::FieldFunction< ValType >:

[legend]

Public Member Functions
	FieldFunction (const std::string &nm)

virtual void	operator() (ValType &v) const
	calculates the value of the function and returns it in `v`. More...

virtual void	perturbation (ValType &v) const
	calculates the perturbation and returns it in `v`. More...

virtual void	derivative (const MAST::FunctionBase &f, ValType &v) const
	calculates the value of the function derivative and returns it in `v`. More...

virtual void	operator() (const libMesh::Point &p, const Real t, ValType &v) const
	calculates the value of the function at the specified point, `p`, and time, `t`, and returns it in `v`. More...

virtual void	perturbation (const libMesh::Point &p, const Real t, ValType &v) const
	calculates the value of a perturbation in function at the specified point, `p`, and time, `t`, and returns it in `v`. More...

virtual void	derivative (const MAST::FunctionBase &f, const libMesh::Point &p, const Real t, ValType &v) const
	calculates the value of the derivative of function with respect to the function `f` at the specified point, `p`, and time, `t`, and returns it in `v`. More...

Public Member Functions inherited from MAST::FunctionBase
	FunctionBase (const std::string &nm, const bool is_field_func)
	initializes the parameter to the given name More...

	FunctionBase (const MAST::FunctionBase &f)
	Copy constructor. More...

virtual	~FunctionBase ()
	virtual destructor More...

const std::string &	name () const
	returns the name of this function More...

virtual bool	depends_on (const MAST::FunctionBase &f) const
	returns true if the function depends on the provided value More...

virtual bool	is_shape_parameter () const

virtual void	set_as_shape_parameter (bool f)

virtual bool	is_topology_parameter () const

virtual void	set_as_topology_parameter (bool f)

Additional Inherited Members
Protected Attributes inherited from MAST::FunctionBase
std::string	_name
	name of this parameter More...

bool	_is_field_func
	flag to store the nature of field function More...

bool	_is_shape_parameter

bool	_is_topology_parameter

std::set< const MAST::FunctionBase * >	_functions
	set of functions that `this` function depends on More...

Detailed Description

template<typename ValType>
class MAST::FieldFunction< ValType >

This creates the base class for functions that have a saptial and temporal dependence, and provide sensitivity operations with respect to the functions and parameters.

The field-function can provide the following:

function value,
small perturbations to support linearized analyses,
sensitivity with respect to a specified function.

Definition at line 31 of file eigenproblem_assembly_elem_operations.h.

Constructor & Destructor Documentation

template<typename ValType>

MAST::FieldFunction< ValType >::FieldFunction ( const std::string & nm )

inline

Definition at line 51 of file field_function_base.h.

Member Function Documentation

template<typename ValType>

virtual void MAST::FieldFunction< ValType >::derivative	(	const MAST::FunctionBase &	f,
		ValType &	v
	)		const

inlinevirtual

calculates the value of the function derivative and returns it in v.

Reimplemented in MAST::FrequencyFunction, and MAST::ConstantFieldFunction.

Definition at line 78 of file field_function_base.h.

template<typename ValType>

virtual void MAST::FieldFunction< ValType >::derivative	(	const MAST::FunctionBase &	f,
		const libMesh::Point &	p,
		const Real	t,
		ValType &	v
	)		const

inlinevirtual

calculates the value of the derivative of function with respect to the function f at the specified point, p, and time, t, and returns it in v.

Definition at line 115 of file field_function_base.h.

template<typename ValType>

virtual void MAST::FieldFunction< ValType >::operator() ( ValType & v ) const

inlinevirtual

calculates the value of the function and returns it in v.

Reimplemented in MAST::FrequencyFunction, and MAST::ConstantFieldFunction.

Definition at line 59 of file field_function_base.h.

template<typename ValType>

virtual void MAST::FieldFunction< ValType >::operator()	(	const libMesh::Point &	p,
		const Real	t,
		ValType &	v
	)		const

inlinevirtual

calculates the value of the function at the specified point, p, and time, t, and returns it in v.

Definition at line 89 of file field_function_base.h.

template<typename ValType>

virtual void MAST::FieldFunction< ValType >::perturbation ( ValType & v ) const

inlinevirtual

calculates the perturbation and returns it in v.

Definition at line 68 of file field_function_base.h.

Here is the caller graph for this function:

template<typename ValType>

virtual void MAST::FieldFunction< ValType >::perturbation	(	const libMesh::Point &	p,
		const Real	t,
		ValType &	v
	)		const

inlinevirtual

calculates the value of a perturbation in function at the specified point, p, and time, t, and returns it in v.

Reimplemented in MAST::PressureFunction, MAST::MeshFieldFunction, and MAST::ComplexMeshFieldFunction.

Definition at line 102 of file field_function_base.h.

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

/home/travis/build/MASTmultiphysics/mast-multiphysics/src/base/eigenproblem_assembly_elem_operations.h
/home/travis/build/MASTmultiphysics/mast-multiphysics/src/base/field_function_base.h

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename ValType> class MAST::FieldFunction< ValType >

Constructor & Destructor Documentation

Member Function Documentation

template<typename ValType>
class MAST::FieldFunction< ValType >