Detailed Description

template<typename BoundaryConditionData, template< typename, int > class LocalAssemblerImplementation>
class ProcessLib::GenericNaturalBoundaryCondition< BoundaryConditionData, LocalAssemblerImplementation >

Definition at line 23 of file GenericNaturalBoundaryCondition.h.

#include <GenericNaturalBoundaryCondition.h>

Inheritance diagram for ProcessLib::GenericNaturalBoundaryCondition< BoundaryConditionData, LocalAssemblerImplementation >:

[legend]

Collaboration diagram for ProcessLib::GenericNaturalBoundaryCondition< BoundaryConditionData, LocalAssemblerImplementation >:

[legend]

Public Member Functions
template<typename Data >
	GenericNaturalBoundaryCondition (unsigned const integration_order, unsigned const shapefunction_order, NumLib::LocalToGlobalIndexMap const &dof_table_bulk, int const variable_id, int const component_id, unsigned const global_dim, MeshLib::Mesh const &bc_mesh, Data &&data)

void	applyNaturalBC (const double t, std::vector< GlobalVector * > const &x, int const process_id, GlobalMatrix &K, GlobalVector &b, GlobalMatrix *Jac) override

Public Member Functions inherited from ProcessLib::BoundaryCondition
virtual void	getEssentialBCValues (const double, GlobalVector const &, NumLib::IndexValueVector< GlobalIndexType > &) const
	Writes the values of essential BCs to `bc_values`.

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
BoundaryConditionData	_data
	Data used in the assembly of the specific boundary condition.

MeshLib::Mesh const &	_bc_mesh
	A lower-dimensional mesh on which the boundary condition is defined.

std::unique_ptr< NumLib::LocalToGlobalIndexMap >	_dof_table_boundary

std::vector< std::unique_ptr< GenericNaturalBoundaryConditionLocalAssemblerInterface > >	_local_assemblers
	Local assemblers for each element of number of _elements.

Constructor & Destructor Documentation

◆ GenericNaturalBoundaryCondition()

template<typename BoundaryConditionData , template< typename, int > class LocalAssemblerImplementation>

template<typename Data >

ProcessLib::GenericNaturalBoundaryCondition< BoundaryConditionData, LocalAssemblerImplementation >::GenericNaturalBoundaryCondition	(	unsigned const	integration_order,
		unsigned const	shapefunction_order,
		NumLib::LocalToGlobalIndexMap const &	dof_table_bulk,
		int const	variable_id,
		int const	component_id,
		unsigned const	global_dim,
		MeshLib::Mesh const &	bc_mesh,
		Data &&	data )

Create a boundary condition process from given config, DOF-table, and a mesh subset for a given variable and its component. A local DOF-table, a subset of the given one, is constructed.

Definition at line 21 of file GenericNaturalBoundaryCondition-impl.h.

    : _data(std::forward<Data>(data)), _bc_mesh(bc_mesh)
{
    static_assert(std::is_same_v<typename std::decay_t<BoundaryConditionData>,
                                 typename std::decay_t<Data>>,
                  "Type mismatch between declared and passed BC data.");
 
    // check basic data consistency
    if (variable_id >=
            static_cast<int>(dof_table_bulk.getNumberOfVariables()) ||
        component_id >=
            dof_table_bulk.getNumberOfVariableComponents(variable_id))
    {
        OGS_FATAL(
            "Variable id or component id too high. Actual values: ({:d}, "
            "{:d}), "
            "maximum values: ({:d}, {:d}).",
            variable_id, component_id, dof_table_bulk.getNumberOfVariables(),
            dof_table_bulk.getNumberOfVariableComponents(variable_id));
    }
 
    if (!_bc_mesh.getProperties().template existsPropertyVector<std::size_t>(
            MeshLib::getBulkIDString(MeshLib::MeshItemType::Node)))
    {
        OGS_FATAL(
            "The required bulk node ids map does not exist in the boundary "
            "mesh '{:s}'.",
            _bc_mesh.getName());
    }
 
    std::vector<MeshLib::Node*> const& bc_nodes = _bc_mesh.getNodes();
    DBUG(
        "Found {:d} nodes for Natural BCs for the variable {:d} and component "
        "{:d}",
        bc_nodes.size(), variable_id, component_id);
 
    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));
 
    BoundaryConditionAndSourceTerm::createLocalAssemblers<
        LocalAssemblerImplementation>(
        global_dim, _bc_mesh.getElements(), *_dof_table_boundary,
        shapefunction_order, _local_assemblers,
        NumLib::IntegrationOrder{integration_order},
        _bc_mesh.isAxiallySymmetric(), _data);
}

References DBUG(), MeshLib::getBulkIDString(), MeshLib::Node, and OGS_FATAL.

Member Function Documentation

◆ applyNaturalBC()

template<typename BoundaryConditionData , template< typename, int > class LocalAssemblerImplementation>

void ProcessLib::GenericNaturalBoundaryCondition< BoundaryConditionData, LocalAssemblerImplementation >::applyNaturalBC	(	const double	t,
		std::vector< GlobalVector * > const &	x,
		int const	process_id,
		GlobalMatrix &	K,
		GlobalVector &	b,
		GlobalMatrix *	Jac )

overridevirtual

Calls local assemblers which calculate their contributions to the global matrix and the right-hand-side.

Reimplemented from ProcessLib::BoundaryCondition.

Definition at line 81 of file GenericNaturalBoundaryCondition-impl.h.

{
    GlobalExecutor::executeMemberOnDereferenced(
        &GenericNaturalBoundaryConditionLocalAssemblerInterface::assemble,
        _local_assemblers, *_dof_table_boundary, t, x, process_id, K, b, Jac);
}

References NumLib::SerialExecutor::executeMemberOnDereferenced().

Member Data Documentation

◆ _bc_mesh

template<typename BoundaryConditionData , template< typename, int > class LocalAssemblerImplementation>

MeshLib::Mesh const& ProcessLib::GenericNaturalBoundaryCondition< BoundaryConditionData, LocalAssemblerImplementation >::_bc_mesh

private

A lower-dimensional mesh on which the boundary condition is defined.

Definition at line 47 of file GenericNaturalBoundaryCondition.h.

◆ _data

template<typename BoundaryConditionData , template< typename, int > class LocalAssemblerImplementation>

BoundaryConditionData ProcessLib::GenericNaturalBoundaryCondition< BoundaryConditionData, LocalAssemblerImplementation >::_data

private

Data used in the assembly of the specific boundary condition.

Definition at line 44 of file GenericNaturalBoundaryCondition.h.

◆ _dof_table_boundary

template<typename BoundaryConditionData , template< typename, int > class LocalAssemblerImplementation>

std::unique_ptr<NumLib::LocalToGlobalIndexMap> ProcessLib::GenericNaturalBoundaryCondition< BoundaryConditionData, LocalAssemblerImplementation >::_dof_table_boundary

private

Local dof table, a subset of the global one restricted to the participating number of _elements of the boundary condition.

Definition at line 51 of file GenericNaturalBoundaryCondition.h.

◆ _local_assemblers

template<typename BoundaryConditionData , template< typename, int > class LocalAssemblerImplementation>

std::vector< std::unique_ptr<GenericNaturalBoundaryConditionLocalAssemblerInterface> > ProcessLib::GenericNaturalBoundaryCondition< BoundaryConditionData, LocalAssemblerImplementation >::_local_assemblers

private

Local assemblers for each element of number of _elements.

Definition at line 56 of file GenericNaturalBoundaryCondition.h.

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

ProcessLib/BoundaryConditionAndSourceTerm/GenericNaturalBoundaryCondition.h
ProcessLib/BoundaryConditionAndSourceTerm/GenericNaturalBoundaryCondition-impl.h

Detailed Description

Public Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ GenericNaturalBoundaryCondition()

Member Function Documentation

◆ applyNaturalBC()

Member Data Documentation

◆ _bc_mesh

◆ _data

◆ _dof_table_boundary

◆ _local_assemblers