#include <frequency_function.h>

Inheritance diagram for MAST::FrequencyFunction:

Collaboration diagram for MAST::FrequencyFunction:

Public Member Functions
	FrequencyFunction (const std::string &nm, MAST::FieldFunction< Real > &omega, MAST::FieldFunction< Real > &velocity, MAST::FieldFunction< Real > &b_ref)

virtual	~FrequencyFunction ()

bool	if_nondimensional () const

void	if_nondimensional (bool v)
	sets the flag for whether or not the frequency has been nondimensionalized: omega b/V More...

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

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

void	nondimensionalizing_factor (Real &v)

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

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

virtual void	derivative (const MAST::FunctionBase &f, const libMesh::Point &p, const Real t, Real &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)

Protected Attributes
bool	_if_red_freq

MAST::FieldFunction< Real > &	_omega

MAST::FieldFunction< Real > &	_velocity

MAST::FieldFunction< Real > &	_b_ref

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

Constructor & Destructor Documentation

MAST::FrequencyFunction::FrequencyFunction	(	const std::string &	nm,
		MAST::FieldFunction< Real > &	omega,
		MAST::FieldFunction< Real > &	velocity,
		MAST::FieldFunction< Real > &	b_ref
	)

Definition at line 25 of file frequency_function.cpp.

MAST::FrequencyFunction::~FrequencyFunction ( )

virtual

Definition at line 42 of file frequency_function.cpp.

Member Function Documentation

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

virtual

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

Reimplemented from MAST::FieldFunction< Real >.

Definition at line 68 of file frequency_function.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool MAST::FrequencyFunction::if_nondimensional ( ) const

inline

Returns: the flag for whether or not the frequency has been nondimensionalized: omega b/V

Definition at line 50 of file frequency_function.h.

void MAST::FrequencyFunction::if_nondimensional ( bool v )

inline

sets the flag for whether or not the frequency has been nondimensionalized: omega b/V

Definition at line 60 of file frequency_function.h.

Here is the call graph for this function:

void MAST::FrequencyFunction::nondimensionalizing_factor ( Real & v )

Returns: value of the non-dimensionalizing factor (b/V) to convert frequency (omega) to reduced frequency (omega * b/V)

Definition at line 90 of file frequency_function.cpp.

Here is the caller graph for this function:

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

virtual

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

Reimplemented from MAST::FieldFunction< Real >.

Definition at line 49 of file frequency_function.cpp.

Here is the caller graph for this function:

Member Data Documentation

MAST::FieldFunction<Real> & MAST::FrequencyFunction::_b_ref

protected

Definition at line 94 of file frequency_function.h.

bool MAST::FrequencyFunction::_if_red_freq

protected

Definition at line 91 of file frequency_function.h.

MAST::FieldFunction<Real>& MAST::FrequencyFunction::_omega

protected

Definition at line 94 of file frequency_function.h.

MAST::FieldFunction<Real> & MAST::FrequencyFunction::_velocity

protected

Definition at line 94 of file frequency_function.h.

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

/home/travis/build/MASTmultiphysics/mast-multiphysics/src/aeroelasticity/frequency_function.h
/home/travis/build/MASTmultiphysics/mast-multiphysics/src/aeroelasticity/frequency_function.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation