#include <constant_field_function.h>

Inheritance diagram for MAST::ConstantFieldFunction:

Collaboration diagram for MAST::ConstantFieldFunction:

Public Member Functions
	ConstantFieldFunction (const std::string &nm, const MAST::Parameter &p)

virtual	~ConstantFieldFunction ()

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

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

virtual void	operator() (const libMesh::Point &p, const Real t, Real &v) const
	calculates the value of the 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, Real &v) const
	calculates the value of the function at the specified point, `p`, and time, `t`, and returns it in `v`. More...

Public Member Functions inherited from MAST::FieldFunction< Real >
	FieldFunction (const std::string &nm)

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

virtual void	perturbation (const libMesh::Point &p, const Real t, Real &v) const
	calculates the value of a perturbation in function 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)

Protected Attributes
const MAST::Parameter &	_p
	parameter which defines this field function More...

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

Definition at line 32 of file constant_field_function.h.

Constructor & Destructor Documentation

MAST::ConstantFieldFunction::ConstantFieldFunction	(	const std::string &	nm,
		const MAST::Parameter &	p
	)

Definition at line 27 of file constant_field_function.cpp.

MAST::ConstantFieldFunction::~ConstantFieldFunction ( )

virtual

Definition at line 36 of file constant_field_function.cpp.

Member Function Documentation

void MAST::ConstantFieldFunction::derivative	(	const MAST::FunctionBase &	f,
		Real &	v
	)		const

virtual

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

Reimplemented from MAST::FieldFunction< Real >.

Definition at line 53 of file constant_field_function.cpp.

Here is the call graph for this function:

void MAST::ConstantFieldFunction::derivative	(	const MAST::FunctionBase &	f,
		const libMesh::Point &	p,
		const Real	t,
		Real &	v
	)		const

virtual

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

Reimplemented from MAST::FieldFunction< Real >.

Definition at line 73 of file constant_field_function.cpp.

Here is the call graph for this function:

void MAST::ConstantFieldFunction::operator() ( Real & v ) const

virtual

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

Reimplemented from MAST::FieldFunction< Real >.

Definition at line 44 of file constant_field_function.cpp.

void MAST::ConstantFieldFunction::operator()	(	const libMesh::Point &	p,
		const Real	t,
		Real &	v
	)		const

virtual

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

Reimplemented from MAST::FieldFunction< Real >.

Definition at line 63 of file constant_field_function.cpp.

Member Data Documentation

const MAST::Parameter& MAST::ConstantFieldFunction::_p

protected

parameter which defines this field function

Definition at line 85 of file constant_field_function.h.

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

/home/travis/build/MASTmultiphysics/mast-multiphysics/src/base/constant_field_function.h
/home/travis/build/MASTmultiphysics/mast-multiphysics/src/base/constant_field_function.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation