b2000::TypedEssentialBoundaryCondition< T > Class Template Reference

#include "b2boundary_condition.H"

Inheritance diagram for b2000::TypedEssentialBoundaryCondition< T >:

Collaboration diagram for b2000::TypedEssentialBoundaryCondition< T >:

Public Types
typedef TypedEssentialBoundaryCondition	typed_base_t
Public Types inherited from b2000::EssentialBoundaryCondition
enum	Type { none = 0 , constant_value = 1 , constant_derivative = 2 , noconstant_derivative = 3 }

Public Member Functions
virtual void	get_nonlinear_value (const b2linalg::Vector< T, b2linalg::Vdense_constref > &dof, double time, EquilibriumSolution equilibrium_solution, b2linalg::Vector< T, b2linalg::Vdense_ref > value, b2linalg::Matrix< T, b2linalg::Mcompressed_col > &d_value_d_dof_trans, b2linalg::Vector< T, b2linalg::Vdense_ref > d_value_d_time, SolverHints *solver_hints)
virtual void	get_linear_value (b2linalg::Vector< T, b2linalg::Vdense_ref > value, b2linalg::Matrix< T, b2linalg::Mcompressed_col > &d_value_d_dof_trans, double time=1)
Public Member Functions inherited from b2000::EssentialBoundaryCondition
virtual Type	get_type () const =0
virtual size_t	get_size (const bool linear)=0
Public Member Functions inherited from b2000::Object
virtual const std::string &	get_object_name () const
virtual	~Object ()

Additional Inherited Members
Static Public Attributes inherited from b2000::Object
static ObjectType	type

Detailed Description

template<typename T>
class b2000::TypedEssentialBoundaryCondition< T >

Abstract class defining the complete interface for essential boundary conditions. Actual implementations should derive this class.

Member Typedef Documentation

typed_base_t

template<typename T >

typedef TypedEssentialBoundaryCondition b2000::TypedEssentialBoundaryCondition< T >::typed_base_t

Indicating the boundary type as an easy handle to use in derived classes.

Member Function Documentation

get_linear_value()

template<typename T >

virtual void b2000::TypedEssentialBoundaryCondition< T >::get_linear_value ( b2linalg::Vector< T, b2linalg::Vdense_ref >  value, b2linalg::Matrix< T, b2linalg::Mcompressed_col > &  d_value_d_dof_trans, double  time = 1  )

inlinevirtual

Evaluate a linear essential boundary condition. By default, get_nonlinear_value() is called with dof set to zero and time set to 1.

Parameters

value	The values of g (global array, output).
d_value_d_dof_trans	A transposed matrix containing the derivatives of g w.r.t. the dof's (sparse matrix, output).
time	The current time parameter (input).

get_nonlinear_value()

template<typename T >

virtual void b2000::TypedEssentialBoundaryCondition< T >::get_nonlinear_value ( const b2linalg::Vector< T, b2linalg::Vdense_constref > &  dof, double  time, EquilibriumSolution  equilibrium_solution, b2linalg::Vector< T, b2linalg::Vdense_ref >  value, b2linalg::Matrix< T, b2linalg::Mcompressed_col > &  d_value_d_dof_trans, b2linalg::Vector< T, b2linalg::Vdense_ref >  d_value_d_time, SolverHints *  solver_hints  )

inlinevirtual

Evaluate a nonlinear essential boundary condition. Actual implementations must override this function.

Parameters

dof	The degrees-of-freedom (global array, input).
time	The current time parameter (input).
equilibrium_solution	Contains information for path-dependent analysis.
value	The evaluation of g in function the dof's and the time (global array, output).
d_value_d_dof_trans	A transposed matrix containing the derivatives of g w.r.t. the dof's (sparse matrix, output).
d_value_d_time	The derivatives of g w.r.t. the time parameter (global array, output).
solver_hints	Hints for the Solver that can be specified by the natural boundary condition.

---

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

• model/b2boundary_condition.H