Detailed Description

Definition at line 41 of file dirichlet_boundary_condition.h.

#include <dirichlet_boundary_condition.h>

Inheritance diagram for MAST::DirichletBoundaryCondition:

Collaboration diagram for MAST::DirichletBoundaryCondition:

Public Member Functions
	DirichletBoundaryCondition ()

virtual	~DirichletBoundaryCondition ()

libMesh::DirichletBoundary &	dirichlet_boundary ()

void	init (const libMesh::boundary_id_type bid, const std::vector< unsigned int > &constrained_vars, MAST::FieldFunction< RealVectorX > *f_val=nullptr, libMesh::VariableIndexing index=libMesh::SYSTEM_VARIABLE_ORDER, unsigned int n_sys_vars=0)
	initializes the object for the specified domain id (either boundary, or subdomain), for the displacement components initialized using a bitwise operator. More...

Public Member Functions inherited from MAST::BoundaryConditionBase
	BoundaryConditionBase (MAST::BoundaryConditionType t)

virtual	~BoundaryConditionBase ()

MAST::BoundaryConditionType	type () const

Public Member Functions inherited from MAST::FunctionSetBase
	FunctionSetBase ()

virtual	~FunctionSetBase ()
	destructor deletes the function pointers More...

void	add (MAST::FunctionBase &f)
	adds the function to this card and returns a reference to it. More...

bool	contains (const std::string &nm) const
	checks if the card contains the specified property value More...

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

template<typename ValType >
const ValType &	get (const std::string &nm) const
	returns a constant reference to the specified function More...

template<typename ValType >
ValType &	get (const std::string &nm)
	returns a writable reference to the specified function More...

Protected Attributes
std::unique_ptr< libMesh::DirichletBoundary >	_dirichlet_boundary
	Dirichlet boundary function for this boundary. More...

Protected Attributes inherited from MAST::BoundaryConditionBase
MAST::BoundaryConditionType	_bc_type

Protected Attributes inherited from MAST::FunctionSetBase
std::map< std::string, MAST::FunctionBase * >	_properties
	map of the functions in this card More...

Constructor & Destructor Documentation

◆ DirichletBoundaryCondition()

MAST::DirichletBoundaryCondition::DirichletBoundaryCondition ( )

inline

Definition at line 45 of file dirichlet_boundary_condition.h.

◆ ~DirichletBoundaryCondition()

virtual MAST::DirichletBoundaryCondition::~DirichletBoundaryCondition ( )

inlinevirtual

Definition at line 49 of file dirichlet_boundary_condition.h.

Member Function Documentation

◆ dirichlet_boundary()

libMesh::DirichletBoundary& MAST::DirichletBoundaryCondition::dirichlet_boundary ( )

inline

Returns: reference to the Dirichlet boundary condition object

Definition at line 77 of file dirichlet_boundary_condition.h.

◆ init()

void MAST::DirichletBoundaryCondition::init	(	const libMesh::boundary_id_type	bid,
		const std::vector< unsigned int > &	constrained_vars,
		MAST::FieldFunction< RealVectorX > *	f_val = `nullptr`,
		libMesh::VariableIndexing	index = `libMesh::SYSTEM_VARIABLE_ORDER`,
		unsigned int	n_sys_vars = `0`
	)

initializes the object for the specified domain id (either boundary, or subdomain), for the displacement components initialized using a bitwise operator.

This method initializes the components to zero value on the domain. If f_val is not provided then a zero value is assumed for all constrained variables. FieldFunction should implement a method that provides a vector containing the value of constrained variables at specified spatial point and time. The order of variables in this vector is based on the value of index. If index = libMesh::SYSTEM_VARIABLE_ORDER, which is the default, then the i^th component of the vector returned by f_val is the value of the i^th system variable. On the other hand, if If index = libMesh::LOCAL_VARIABLE_ORDER, then the i^th component of the vector returned by f_val is the value of the i^th component in constrained_vars. If index = libMesh::SYSTEM_VARIABLE_ORDER then n_vars should be set to the number of variables in the system.

Returns: The scalar function value at coordinate p and time time, which defaults to zero.

Pure virtual, so you have to override it.

Definition at line 30 of file dirichlet_boundary_condition.cpp.

Member Data Documentation

◆ _dirichlet_boundary

std::unique_ptr<libMesh::DirichletBoundary> MAST::DirichletBoundaryCondition::_dirichlet_boundary

protected

Dirichlet boundary function for this boundary.

Definition at line 86 of file dirichlet_boundary_condition.h.

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

/home/travis/build/MASTmultiphysics/mast-multiphysics/src/boundary_condition/dirichlet_boundary_condition.h
/home/travis/build/MASTmultiphysics/mast-multiphysics/src/boundary_condition/dirichlet_boundary_condition.cpp