Detailed Description

Definition at line 29 of file level_set_boundary_velocity.h.

#include <level_set_boundary_velocity.h>

Inheritance diagram for MAST::LevelSetBoundaryVelocity:

Collaboration diagram for MAST::LevelSetBoundaryVelocity:

[legend]

Public Member Functions
	LevelSetBoundaryVelocity (const unsigned int dim)

virtual	~LevelSetBoundaryVelocity ()

void	attach_level_set_function (const MAST::FieldFunction< Real > &phi)
	attaches the level set function `phi` with this object. More...

void	clear ()

void	clear_level_set_function ()
	clears the attached level set function More...

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

void	init (MAST::SystemInitialization &sys, const MAST::MeshFieldFunction &phi)

void	normal_at_point (const libMesh::Point &p, const Real t, RealVectorX &n) const

void	normal_derivative_at_point (const MAST::FunctionBase &f, const libMesh::Point &p, const Real t, RealVectorX &n) const

void	search_nearest_interface_point (const libMesh::Elem &e, const unsigned int side, const libMesh::Point &p, const Real t, RealVectorX &pt) const

void	search_nearest_interface_point_derivative (const MAST::FunctionBase &f, const libMesh::Elem &e, const unsigned int side, const libMesh::Point &p, const Real t, RealVectorX &v) const

void	search_nearest_interface_point_derivative_old (const MAST::FunctionBase &f, const libMesh::Point &p, const Real t, const Real length, RealVectorX &v) const
	serches for a point `pt` in the vicinity of `p` on the level set interface, where level set function is zero. More...

void	search_nearest_interface_point_old (const libMesh::Point &p, const Real t, const Real length, RealVectorX &pt, bool allow_sub_search=true) const
	serches for a point `pt` in the vicinity of `p` on the level set interface, where level set function is zero. More...

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

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	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 (RealVectorX &v) const
	calculates the perturbation and returns it in `v`. More...

virtual void	perturbation (const libMesh::Point &p, const Real t, RealVectorX &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...

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
Real	_evaluate_point_search_obj (const libMesh::Point &p, const Real t, const RealVectorX &dv) const

Protected Attributes
unsigned int	_dim

const MAST::FieldFunction< Real > *	_level_set_func

libMesh::MeshBase *	_mesh

const MAST::MeshFieldFunction *	_phi

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

◆ LevelSetBoundaryVelocity()

MAST::LevelSetBoundaryVelocity::LevelSetBoundaryVelocity ( const unsigned int dim )

Definition at line 27 of file level_set_boundary_velocity.cpp.

◆ ~LevelSetBoundaryVelocity()

MAST::LevelSetBoundaryVelocity::~LevelSetBoundaryVelocity ( )

virtual

Definition at line 36 of file level_set_boundary_velocity.cpp.

Member Function Documentation

◆ _evaluate_point_search_obj()

Real MAST::LevelSetBoundaryVelocity::_evaluate_point_search_obj	(	const libMesh::Point &	p,
		const Real	t,
		const RealVectorX &	dv
	)		const

protected

Definition at line 447 of file level_set_boundary_velocity.cpp.

◆ attach_level_set_function()

void MAST::LevelSetBoundaryVelocity::attach_level_set_function ( const MAST::FieldFunction< Real > & phi )

attaches the level set function phi with this object.

This is necessary only when the interface point functions are used.

Definition at line 121 of file level_set_boundary_velocity.cpp.

◆ clear()

void MAST::LevelSetBoundaryVelocity::clear ( )

Definition at line 54 of file level_set_boundary_velocity.cpp.

◆ clear_level_set_function()

void MAST::LevelSetBoundaryVelocity::clear_level_set_function ( )

clears the attached level set function

Definition at line 130 of file level_set_boundary_velocity.cpp.

◆ derivative()

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

virtual

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.

Reimplemented from MAST::FieldFunction< RealVectorX >.

Definition at line 63 of file level_set_boundary_velocity.cpp.

◆ init()

void MAST::LevelSetBoundaryVelocity::init	(	MAST::SystemInitialization &	sys,
		const MAST::MeshFieldFunction &	phi
	)

Definition at line 42 of file level_set_boundary_velocity.cpp.

◆ normal_at_point()

void MAST::LevelSetBoundaryVelocity::normal_at_point	(	const libMesh::Point &	p,
		const Real	t,
		RealVectorX &	n
	)		const

Definition at line 396 of file level_set_boundary_velocity.cpp.

◆ normal_derivative_at_point()

void MAST::LevelSetBoundaryVelocity::normal_derivative_at_point	(	const MAST::FunctionBase &	f,
		const libMesh::Point &	p,
		const Real	t,
		RealVectorX &	n
	)		const

Definition at line 418 of file level_set_boundary_velocity.cpp.

◆ search_nearest_interface_point()

void MAST::LevelSetBoundaryVelocity::search_nearest_interface_point	(	const libMesh::Elem &	e,
		const unsigned int	side,
		const libMesh::Point &	p,
		const Real	t,
		RealVectorX &	pt
	)		const

Definition at line 139 of file level_set_boundary_velocity.cpp.

◆ search_nearest_interface_point_derivative()

void MAST::LevelSetBoundaryVelocity::search_nearest_interface_point_derivative	(	const MAST::FunctionBase &	f,
		const libMesh::Elem &	e,
		const unsigned int	side,
		const libMesh::Point &	p,
		const Real	t,
		RealVectorX &	v
	)		const

Definition at line 171 of file level_set_boundary_velocity.cpp.

◆ search_nearest_interface_point_derivative_old()

void MAST::LevelSetBoundaryVelocity::search_nearest_interface_point_derivative_old	(	const MAST::FunctionBase &	f,
		const libMesh::Point &	p,
		const Real	t,
		const Real	length,
		RealVectorX &	v
	)		const

serches for a point pt in the vicinity of p on the level set interface, where level set function is zero.

length is a reference length that is used to identify the step-size for the search. If the interface point is expected to be within a few elements, then this length coudl be the element edge length.

Definition at line 371 of file level_set_boundary_velocity.cpp.

◆ search_nearest_interface_point_old()

void MAST::LevelSetBoundaryVelocity::search_nearest_interface_point_old	(	const libMesh::Point &	p,
		const Real	t,
		const Real	length,
		RealVectorX &	pt,
		bool	allow_sub_search = `true`
	)		const

serches for a point pt in the vicinity of p on the level set interface, where level set function is zero.

length is a reference length that is used to identify the step-size for the search. If the interface point is expected to be within a few elements, then this length coudl be the element edge length.

Definition at line 198 of file level_set_boundary_velocity.cpp.

◆ velocity()

void MAST::LevelSetBoundaryVelocity::velocity	(	const MAST::FunctionBase &	f,
		const libMesh::Point &	p,
		const Real	t,
		RealVectorX &	v
	)		const

Definition at line 72 of file level_set_boundary_velocity.cpp.

Member Data Documentation

◆ _dim

unsigned int MAST::LevelSetBoundaryVelocity::_dim

protected

Definition at line 118 of file level_set_boundary_velocity.h.

◆ _level_set_func

const MAST::FieldFunction<Real>* MAST::LevelSetBoundaryVelocity::_level_set_func

protected

Definition at line 121 of file level_set_boundary_velocity.h.

◆ _mesh

libMesh::MeshBase* MAST::LevelSetBoundaryVelocity::_mesh

protected

Definition at line 120 of file level_set_boundary_velocity.h.

◆ _phi

const MAST::MeshFieldFunction* MAST::LevelSetBoundaryVelocity::_phi

protected

Definition at line 119 of file level_set_boundary_velocity.h.

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

/home/travis/build/MASTmultiphysics/mast-multiphysics/src/level_set/level_set_boundary_velocity.h
/home/travis/build/MASTmultiphysics/mast-multiphysics/src/level_set/level_set_boundary_velocity.cpp

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ LevelSetBoundaryVelocity()

◆ ~LevelSetBoundaryVelocity()

Member Function Documentation

◆ _evaluate_point_search_obj()

◆ attach_level_set_function()

◆ clear()

◆ clear_level_set_function()

◆ derivative()

◆ init()

◆ normal_at_point()

◆ normal_derivative_at_point()

◆ search_nearest_interface_point()

◆ search_nearest_interface_point_derivative()

◆ search_nearest_interface_point_derivative_old()

◆ search_nearest_interface_point_old()

◆ velocity()

Member Data Documentation

◆ _dim

◆ _level_set_func

◆ _mesh

◆ _phi