ProcessLib/BoundaryConditionAndSourceTerm/BoundaryCondition.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include "NumLib/NumericsConfig.h"
 
namespace MeshLib
{
class Mesh;
}
 
namespace NumLib
{
class LocalToGlobalIndexMap;
template <typename>
struct IndexValueVector;
}  // namespace NumLib
namespace ParameterLib
{
struct ParameterBase;
}
namespace ProcessLib
{
struct BoundaryConditionConfig;
class Process;
 
class BoundaryCondition
{
public:
    virtual void applyNaturalBC(const double /*t*/,
                                std::vector<GlobalVector*> const& /*x*/,
                                int const /*process_id*/, GlobalMatrix* /*K*/,
                                GlobalVector& /*b*/, GlobalMatrix* /*Jac*/)
    {
        // By default it is assumed that the BC is not a natural BC. Therefore
        // there is nothing to do here.
    }

    virtual void getEssentialBCValues(
        const double /*t*/, GlobalVector const& /*x*/,
        NumLib::IndexValueVector<GlobalIndexType>& /*bc_values*/) const
    {
        // By default it is assumed that the BC is not an essential BC.
        // Therefore there is nothing to do here.
    }
 
    virtual void preTimestep(const double /*t*/,
                             std::vector<GlobalVector*> const& /*x*/,
                             int const /*process_id*/)
    {
        // A hook added for solution dependent dirichlet
    }
 
    virtual void postTimestep(const double /*t*/,
                              std::vector<GlobalVector*> const& /*x*/,
                              int const /*process_id*/)
    {
        // A hook added for solution dependent dirichlet
    }
 
    virtual ~BoundaryCondition() = default;
};
 
}  // namespace ProcessLib