Detailed Description

The PrimaryVariableConstraintDirichletBoundaryCondition is a Dirichlet-type boundary condition.

The class implements a constraint Dirichlet-type boundary condition. Using a threshold for the primary variable which is given by a parameter the boundary condition can be switched on/off. The value that is set a Dirichlet-type boundary condition is given by another parameter.

Definition at line 36 of file PrimaryVariableConstraintDirichletBoundaryCondition.h.

#include <PrimaryVariableConstraintDirichletBoundaryCondition.h>

Inheritance diagram for ProcessLib::PrimaryVariableConstraintDirichletBoundaryCondition:

[legend]

Collaboration diagram for ProcessLib::PrimaryVariableConstraintDirichletBoundaryCondition:

[legend]

Public Member Functions
	PrimaryVariableConstraintDirichletBoundaryCondition (ParameterLib::Parameter< double > const &parameter, MeshLib::Mesh const &bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_bulk, int const variable_id, int const component_id, ParameterLib::Parameter< double > const &threshold_parameter, bool const less)

void	getEssentialBCValues (const double t, GlobalVector const &x, NumLib::IndexValueVector< GlobalIndexType > &bc_values) const override
	Writes the values of essential BCs to `bc_values`.

Public Member Functions inherited from ProcessLib::BoundaryCondition
virtual void	applyNaturalBC (const double, std::vector< GlobalVector * > const &, int const, GlobalMatrix , GlobalVector &, GlobalMatrix )

virtual void	preTimestep (const double, std::vector< GlobalVector * > const &, int const)

virtual void	postTimestep (const double, std::vector< GlobalVector * > const &, int const)

virtual	~BoundaryCondition ()=default

Private Attributes
ParameterLib::Parameter< double > const &	_parameter
	< parameter that defines the Dirirchlet-type condition values

MeshLib::Mesh const &	_bc_mesh

std::unique_ptr< NumLib::LocalToGlobalIndexMap const >	_dof_table_boundary

int const	_variable_id

int const	_component_id

ParameterLib::Parameter< double > const &	_threshold_parameter

bool const	_less

Constructor & Destructor Documentation

◆ PrimaryVariableConstraintDirichletBoundaryCondition()

ProcessLib::PrimaryVariableConstraintDirichletBoundaryCondition::PrimaryVariableConstraintDirichletBoundaryCondition	(	ParameterLib::Parameter< double > const &	parameter,
		MeshLib::Mesh const &	bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_bulk,
		int const	variable_id,
		int const	component_id,
		ParameterLib::Parameter< double > const &	threshold_parameter,
		bool const	less )

Definition at line 27 of file PrimaryVariableConstraintDirichletBoundaryCondition.cpp.

    : _parameter(parameter),
      _bc_mesh(bc_mesh),
      _variable_id(variable_id),
      _component_id(component_id),
      _threshold_parameter(threshold_parameter),
      _less(less)
{
    checkParametersOfDirichletBoundaryCondition(_bc_mesh, dof_table_bulk,
                                                _variable_id, _component_id);
 
    std::vector<MeshLib::Node*> const& bc_nodes = bc_mesh.getNodes();
    MeshLib::MeshSubset bc_mesh_subset(_bc_mesh, bc_nodes);
 
    // Create local DOF table from the BC mesh subset for the given variable
    // and component id.
    _dof_table_boundary = dof_table_bulk.deriveBoundaryConstrainedMap(
        variable_id, {component_id}, std::move(bc_mesh_subset));
}

References _bc_mesh, _component_id, _dof_table_boundary, _variable_id, ProcessLib::checkParametersOfDirichletBoundaryCondition(), NumLib::LocalToGlobalIndexMap::deriveBoundaryConstrainedMap(), and MeshLib::Mesh::getNodes().

Member Function Documentation

◆ getEssentialBCValues()

void ProcessLib::PrimaryVariableConstraintDirichletBoundaryCondition::getEssentialBCValues	(	const double	,
		GlobalVector const &	,
		NumLib::IndexValueVector< GlobalIndexType > &	) const

overridevirtual

Writes the values of essential BCs to bc_values.

Reimplemented from ProcessLib::BoundaryCondition.

Definition at line 54 of file PrimaryVariableConstraintDirichletBoundaryCondition.cpp.

{
    ParameterLib::SpatialPosition pos;
 
    bc_values.ids.clear();
    bc_values.values.clear();
 
    auto const& nodes_in_bc_mesh = _bc_mesh.getNodes();
    // convert mesh node ids to global index for the given component
    bc_values.ids.reserve(bc_values.ids.size() + nodes_in_bc_mesh.size());
    bc_values.values.reserve(bc_values.values.size() + nodes_in_bc_mesh.size());
    for (auto const* const node : nodes_in_bc_mesh)
    {
        auto const id = node->getID();
        // TODO: that might be slow, but only done once
        auto const global_index = _dof_table_boundary->getGlobalIndex(
            {_bc_mesh.getID(), MeshLib::MeshItemType::Node, id}, _variable_id,
            _component_id);
        if (global_index == NumLib::MeshComponentMap::nop)
        {
            continue;
        }
        // For the DDC approach (e.g. with PETSc option), the negative
        // index of global_index means that the entry by that index is a ghost
        // one, which should be dropped. Especially for PETSc routines
        // MatZeroRows and MatZeroRowsColumns, which are called to apply the
        // Dirichlet BC, the negative index is not accepted like other matrix or
        // vector PETSc routines. Therefore, the following if-condition is
        // applied.
        if (global_index >= 0)
        {
            // fetch the value of the primary variable
            auto const local_x = x.get(std::vector{global_index});
            pos.setNodeID(id);
            pos.setCoordinates(*node);
            if (_less && local_x[0] < _threshold_parameter(t, pos).front())
            {
                bc_values.ids.emplace_back(global_index);
                bc_values.values.emplace_back(_parameter(t, pos).front());
            }
            else if (!_less &&
                     local_x[0] > _threshold_parameter(t, pos).front())
            {
                bc_values.ids.emplace_back(global_index);
                bc_values.values.emplace_back(_parameter(t, pos).front());
            }
        }
    }
}

References _bc_mesh, _component_id, _dof_table_boundary, _less, _parameter, _threshold_parameter, _variable_id, MathLib::EigenVector::get(), MeshLib::Mesh::getID(), MeshLib::Mesh::getNodes(), NumLib::IndexValueVector< typename >::ids, MeshLib::Node, NumLib::MeshComponentMap::nop, ParameterLib::SpatialPosition::setCoordinates(), ParameterLib::SpatialPosition::setNodeID(), and NumLib::IndexValueVector< typename >::values.

Member Data Documentation

◆ _bc_mesh

MeshLib::Mesh const& ProcessLib::PrimaryVariableConstraintDirichletBoundaryCondition::_bc_mesh

private

Definition at line 56 of file PrimaryVariableConstraintDirichletBoundaryCondition.h.

Referenced by PrimaryVariableConstraintDirichletBoundaryCondition(), and getEssentialBCValues().

◆ _component_id

int const ProcessLib::PrimaryVariableConstraintDirichletBoundaryCondition::_component_id

private

Definition at line 59 of file PrimaryVariableConstraintDirichletBoundaryCondition.h.

Referenced by PrimaryVariableConstraintDirichletBoundaryCondition(), and getEssentialBCValues().

◆ _dof_table_boundary

std::unique_ptr<NumLib::LocalToGlobalIndexMap const> ProcessLib::PrimaryVariableConstraintDirichletBoundaryCondition::_dof_table_boundary

private

Definition at line 57 of file PrimaryVariableConstraintDirichletBoundaryCondition.h.

Referenced by PrimaryVariableConstraintDirichletBoundaryCondition(), and getEssentialBCValues().

◆ _less

bool const ProcessLib::PrimaryVariableConstraintDirichletBoundaryCondition::_less

private

The value less is used for the calculation of the constraint criterion. If less is set to true (i.e. 'less' is set in the project file) the criterion 'calculated_value < _threshold_parameter' is evaluated to switch on/off the boundary condition. If less will be set to false in case 'greater' is given in the project file and the condition 'calculated_value > _threshold_parameter' is evaluated.

Definition at line 73 of file PrimaryVariableConstraintDirichletBoundaryCondition.h.

Referenced by getEssentialBCValues().