Detailed Description

This provides a wrapper FieldFunction compatible class that interpolates the solution using libMesh's MeshFunction class.

Definition at line 44 of file mesh_field_function.h.

#include <mesh_field_function.h>

Inheritance diagram for MAST::MeshFieldFunction:

[legend]

Collaboration diagram for MAST::MeshFieldFunction:

[legend]

Classes
struct	SolFunc

Public Member Functions
	MeshFieldFunction (MAST::SystemInitialization &sys, const std::string &nm, libMesh::ParallelType p_type)
	constructor More...

	MeshFieldFunction (libMesh::System &sys, const std::string &nm, libMesh::ParallelType p_type)
	constructor More...

virtual	~MeshFieldFunction ()
	destructor More...

void	clear ()
	clear the solution More...

virtual void	clear_element_quadrature_point_solution ()
	clears the quadrature point solution provided by the corresponding set method above. More...

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

libMesh::MeshFunction &	get_function ()

libMesh::MeshFunction &	get_perturbed_function ()

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

void	init (const libMesh::NumericVector< Real > &sol, bool reuse_vector)
	initializes the data structures to perform the interpolation function of `sol`. More...

void	init_sens (const MAST::FunctionBase &f, const libMesh::NumericVector< Real > &dsol, bool reuse_vector)
	initializes the the data structures for computation of sensitivity for the specified function. More...

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

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

virtual void	set_element_quadrature_point_solution (RealVectorX &sol)
	When a mesh field function is attached to an assembly routine during system assembly, then the current solution can be provided by the element quadrature point update. More...

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

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

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

virtual void	perturbation (RealVectorX &v) const
	calculates the perturbation 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...

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 bool	is_topology_parameter () const

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

virtual void	set_as_shape_parameter (bool f)

virtual void	set_as_topology_parameter (bool f)

Protected Member Functions
void	_init_sol_func (bool reuse_sol, const libMesh::NumericVector< Real > &sol, MAST::MeshFieldFunction::SolFunc &sol_func)

Protected Attributes
SolFunc *	_function
	current solution that is going to be interpolated More...

std::map< const MAST::FunctionBase , MAST::MeshFieldFunction::SolFunc >	_function_sens
	solution sensitivity for specified value More...

libMesh::ParallelType	_p_type
	type of parallel vector required for this mesh function. More...

SolFunc *	_perturbed_function
	current perturbation solution that is going to be interpolated More...

RealVectorX	_qp_sol
	quadrature point solution of the element More...

libMesh::System *	_sys
	current system for which solution is to be interpolated More...

bool	_use_qp_sol
	flag is set to true when the quadrature point solution is provided by an element More...

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

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

bool	_is_shape_parameter

bool	_is_topology_parameter

std::string	_name
	name of this parameter More...

Constructor & Destructor Documentation

◆ MeshFieldFunction() [1/2]

MAST::MeshFieldFunction::MeshFieldFunction	(	MAST::SystemInitialization &	sys,
		const std::string &	nm,
		libMesh::ParallelType	p_type
	)

constructor

Definition at line 30 of file mesh_field_function.cpp.

◆ MeshFieldFunction() [2/2]

MAST::MeshFieldFunction::MeshFieldFunction	(	libMesh::System &	sys,
		const std::string &	nm,
		libMesh::ParallelType	p_type
	)

constructor

Definition at line 45 of file mesh_field_function.cpp.

◆ ~MeshFieldFunction()

MAST::MeshFieldFunction::~MeshFieldFunction ( )

virtual

destructor

Definition at line 60 of file mesh_field_function.cpp.

Member Function Documentation

◆ _init_sol_func()

void MAST::MeshFieldFunction::_init_sol_func	(	bool	reuse_sol,
		const libMesh::NumericVector< Real > &	sol,
		MAST::MeshFieldFunction::SolFunc &	sol_func
	)

protected

Definition at line 366 of file mesh_field_function.cpp.

◆ clear()

void MAST::MeshFieldFunction::clear ( )

clear the solution

Definition at line 315 of file mesh_field_function.cpp.

◆ clear_element_quadrature_point_solution()

void MAST::MeshFieldFunction::clear_element_quadrature_point_solution ( )

virtual

clears the quadrature point solution provided by the corresponding set method above.

Definition at line 358 of file mesh_field_function.cpp.

◆ derivative()

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

Definition at line 205 of file mesh_field_function.cpp.

◆ derivative_gradient()

void MAST::MeshFieldFunction::derivative_gradient	(	const MAST::FunctionBase &	f,
		const libMesh::Point &	p,
		const Real	t,
		RealMatrixX &	v
	)		const

virtual

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

Definition at line 242 of file mesh_field_function.cpp.

◆ get_function()

libMesh::MeshFunction& MAST::MeshFieldFunction::get_function ( )

inline

Returns: a reference to the libMesh mesh function

Definition at line 146 of file mesh_field_function.h.

◆ get_perturbed_function()

libMesh::MeshFunction& MAST::MeshFieldFunction::get_perturbed_function ( )

inline

Returns: a reference to the libMesh mesh function for the perturbation in solution

Definition at line 156 of file mesh_field_function.h.

◆ gradient()

void MAST::MeshFieldFunction::gradient	(	const libMesh::Point &	p,
		const Real	t,
		RealMatrixX &	g
	)		const

virtual

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

g(i,j) = dv(i)/dx(j)

Definition at line 105 of file mesh_field_function.cpp.

◆ init()

void MAST::MeshFieldFunction::init	(	const libMesh::NumericVector< Real > &	sol,
		bool	reuse_vector
	)

initializes the data structures to perform the interpolation function of sol.

If dsol is provided, then it is used as the perturbation of sol. if reuse_vector is true then instead of cloning sol this vector will be used and it should be of type p_type set in the constructor of this object. Note that this requires that sol not be destroyed till this object needs it.

Definition at line 281 of file mesh_field_function.cpp.

◆ init_sens()

void MAST::MeshFieldFunction::init_sens	(	const MAST::FunctionBase &	f,
		const libMesh::NumericVector< Real > &	dsol,
		bool	reuse_vector
	)

initializes the the data structures for computation of sensitivity for the specified function.

Definition at line 294 of file mesh_field_function.cpp.

◆ operator()()

void MAST::MeshFieldFunction::operator()	(	const libMesh::Point &	p,
		const Real	t,
		RealVectorX &	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< RealVectorX >.

Definition at line 72 of file mesh_field_function.cpp.

◆ perturbation()

void MAST::MeshFieldFunction::perturbation	(	const libMesh::Point &	p,
		const Real	t,
		RealVectorX &	v
	)		const

virtual

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

Reimplemented from MAST::FieldFunction< RealVectorX >.

Definition at line 139 of file mesh_field_function.cpp.

◆ perturbation_gradient()

void MAST::MeshFieldFunction::perturbation_gradient	(	const libMesh::Point &	p,
		const Real	t,
		RealMatrixX &	v
	)		const

virtual

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

Definition at line 171 of file mesh_field_function.cpp.

◆ set_element_quadrature_point_solution()

void MAST::MeshFieldFunction::set_element_quadrature_point_solution ( RealVectorX & sol )

virtual

When a mesh field function is attached to an assembly routine during system assembly, then the current solution can be provided by the element quadrature point update.

This method allows the element to provide the solution and in turn override the mesh function evaluation.

Definition at line 348 of file mesh_field_function.cpp.

Member Data Documentation

◆ _function

SolFunc* MAST::MeshFieldFunction::_function

protected

current solution that is going to be interpolated

Definition at line 232 of file mesh_field_function.h.

◆ _function_sens

std::map<const MAST::FunctionBase*, MAST::MeshFieldFunction::SolFunc*> MAST::MeshFieldFunction::_function_sens

protected

solution sensitivity for specified value

Definition at line 243 of file mesh_field_function.h.

◆ _p_type

libMesh::ParallelType MAST::MeshFieldFunction::_p_type

protected

type of parallel vector required for this mesh function.

Definition at line 217 of file mesh_field_function.h.

◆ _perturbed_function

SolFunc* MAST::MeshFieldFunction::_perturbed_function

protected

current perturbation solution that is going to be interpolated

Definition at line 238 of file mesh_field_function.h.

◆ _qp_sol

RealVectorX MAST::MeshFieldFunction::_qp_sol

protected

quadrature point solution of the element

Definition at line 222 of file mesh_field_function.h.

◆ _sys

libMesh::System* MAST::MeshFieldFunction::_sys

protected

current system for which solution is to be interpolated

Definition at line 227 of file mesh_field_function.h.

◆ _use_qp_sol

bool MAST::MeshFieldFunction::_use_qp_sol

protected

flag is set to true when the quadrature point solution is provided by an element

Definition at line 212 of file mesh_field_function.h.

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

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

Detailed Description

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ MeshFieldFunction() [1/2]

◆ MeshFieldFunction() [2/2]

◆ ~MeshFieldFunction()

Member Function Documentation

◆ _init_sol_func()

◆ clear()

◆ clear_element_quadrature_point_solution()

◆ derivative()

◆ derivative_gradient()

◆ get_function()

◆ get_perturbed_function()

◆ gradient()

◆ init()

◆ init_sens()

◆ operator()()

◆ perturbation()

◆ perturbation_gradient()

◆ set_element_quadrature_point_solution()

Member Data Documentation

◆ _function

◆ _function_sens

◆ _p_type

◆ _perturbed_function

◆ _qp_sol

◆ _sys

◆ _use_qp_sol