Conditions.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////////////
//
//  File: Conditions.h
//
//  For more information, please see: http://www.nektar.info/
//
//  The MIT License
//
//  Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
//  Department of Aeronautics, Imperial College London (UK), and Scientific
//  Computing and Imaging Institute, University of Utah (USA).
//
//  Permission is hereby granted, free of charge, to any person obtaining a
//  copy of this software and associated documentation files (the "Software"),
//  to deal in the Software without restriction, including without limitation
//  the rights to use, copy, modify, merge, publish, distribute, sublicense,
//  and/or sell copies of the Software, and to permit persons to whom the
//  Software is furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included
//  in all copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
//  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
//  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
//  DEALINGS IN THE SOFTWARE.
//
//  Description:
//
//
////////////////////////////////////////////////////////////////////////////////
 
#ifndef NEKTAR_SPATIALDOMAINS_BOUNDARYCONDITIONS_H
#define NEKTAR_SPATIALDOMAINS_BOUNDARYCONDITIONS_H
 
#include <map>
#include <string>
 
#include <LibUtilities/BasicUtils/Equation.h>
#include <LibUtilities/BasicUtils/SessionReader.h>
#include <SpatialDomains/MeshGraph.h>
 
namespace Nektar
{
struct OneD;
 
namespace SpatialDomains
{
enum BoundaryConditionType
{
    eDirichlet,
    eNeumann,
    eRobin,
    ePeriodic,
    eNotDefined
};
 
struct BoundaryConditionBase
{
    BoundaryConditionBase(
        BoundaryConditionType type,
        const std::string &userDefined   = std::string("NoUserDefined"),
        LibUtilities::CommSharedPtr comm = LibUtilities::CommSharedPtr())
        : m_comm(comm), m_userDefined(userDefined),
          m_boundaryConditionType(type), m_isTimeDependent(false)
    {
    }
 
    virtual ~BoundaryConditionBase() = default;
 
    BoundaryConditionType GetBoundaryConditionType() const
    {
        return m_boundaryConditionType;
    }
 
    void SetBoundaryConditionType(BoundaryConditionType boundaryType)
    {
        m_boundaryConditionType = boundaryType;
    }
 
    void SetUserDefined(std::string &type)
    {
        m_userDefined = type;
    }
 
    const std::string GetUserDefined() const
    {
        return m_userDefined;
    }
 
    void SetIsTimeDependent(bool value)
    {
        m_isTimeDependent = value;
    }
 
    bool IsTimeDependent(void)
    {
        return m_isTimeDependent;
    }
 
    LibUtilities::CommSharedPtr GetComm()
    {
        return m_comm;
    }
 
    virtual const LibUtilities::EquationSharedPtr &GetEquation() const = 0;
 
protected:
    LibUtilities::CommSharedPtr m_comm;
    std::string m_userDefined;
    BoundaryConditionType m_boundaryConditionType;
    bool m_isTimeDependent;
};
 
struct DirichletBoundaryCondition : public BoundaryConditionBase
{
    DirichletBoundaryCondition(
        const LibUtilities::SessionReaderSharedPtr &pSession,
        const std::string &eqn,
        const std::string &userDefined         = std::string("NoUserDefined"),
        const std::string &filename            = std::string(""),
        const LibUtilities::CommSharedPtr comm = LibUtilities::CommSharedPtr())
        : BoundaryConditionBase(eDirichlet, userDefined, comm),
          m_dirichletCondition(
              MemoryManager<LibUtilities::Equation>::AllocateSharedPtr(
                  pSession->GetInterpreter(), eqn)),
          m_expr(eqn), m_filename(filename)
    {
    }
 
    const LibUtilities::EquationSharedPtr &GetEquation() const override
    {
        return m_dirichletCondition;
    }
 
    LibUtilities::EquationSharedPtr m_dirichletCondition;
    std::string m_expr;
    std::string m_filename;
};
 
struct NeumannBoundaryCondition : public BoundaryConditionBase
{
    NeumannBoundaryCondition(
        const LibUtilities::SessionReaderSharedPtr &pSession,
        const std::string &eqn,
        const std::string &userDefined         = std::string("NoUserDefined"),
        const std::string &filename            = std::string(""),
        const LibUtilities::CommSharedPtr comm = LibUtilities::CommSharedPtr())
        : BoundaryConditionBase(eNeumann, userDefined, comm),
          m_neumannCondition(
              MemoryManager<LibUtilities::Equation>::AllocateSharedPtr(
                  pSession->GetInterpreter(), eqn)),
          m_filename(filename)
    {
    }
 
    const LibUtilities::EquationSharedPtr &GetEquation() const override
    {
        return m_neumannCondition;
    }
 
    LibUtilities::EquationSharedPtr m_neumannCondition;
    std::string m_filename;
};
 
struct RobinBoundaryCondition : public BoundaryConditionBase
{
    RobinBoundaryCondition(
        const LibUtilities::SessionReaderSharedPtr &pSession,
        const std::string &a, const std::string &b,
        const std::string &userDefined         = std::string("NoUserDefined"),
        const std::string &filename            = std::string(""),
        const LibUtilities::CommSharedPtr comm = LibUtilities::CommSharedPtr())
        : BoundaryConditionBase(eRobin, userDefined, comm),
          m_robinFunction(
              MemoryManager<LibUtilities::Equation>::AllocateSharedPtr(
                  pSession->GetInterpreter(), a)),
          m_robinPrimitiveCoeff(
              MemoryManager<LibUtilities::Equation>::AllocateSharedPtr(
                  pSession->GetInterpreter(), b)),
          m_filename(filename)
    {
    }
 
    const LibUtilities::EquationSharedPtr &GetEquation() const override
    {
        return m_robinFunction;
    }
 
    // \frac{\partial {u}}{\partial{n}} +
    // m_robinPrimativeCoeff(x,y,z)*u = m_robinFunction(x,y,z)
    LibUtilities::EquationSharedPtr m_robinFunction;
    LibUtilities::EquationSharedPtr m_robinPrimitiveCoeff;
    std::string m_filename;
};
 
struct PeriodicBoundaryCondition : public BoundaryConditionBase
{
    PeriodicBoundaryCondition(
        const unsigned int n,
        const std::string &userDefined         = std::string("NoUserDefined"),
        const LibUtilities::CommSharedPtr comm = LibUtilities::CommSharedPtr())
        : BoundaryConditionBase(ePeriodic, userDefined, comm),
          m_connectedBoundaryRegion(n)
    {
    }
 
    const LibUtilities::EquationSharedPtr &GetEquation() const override
    {
        static LibUtilities::EquationSharedPtr empty;
        return empty;
    }
 
    unsigned int m_connectedBoundaryRegion;
};
 
struct NotDefinedBoundaryCondition : public BoundaryConditionBase
{
 
    NotDefinedBoundaryCondition(
        const LibUtilities::SessionReaderSharedPtr &pSession,
        const std::string &eqn,
        const std::string &userDefined         = std::string("NoUserDefined"),
        const std::string &filename            = std::string(""),
        const LibUtilities::CommSharedPtr comm = LibUtilities::CommSharedPtr())
        : BoundaryConditionBase(eNotDefined, userDefined, comm),
          m_notDefinedCondition(
              MemoryManager<LibUtilities::Equation>::AllocateSharedPtr(
                  pSession->GetInterpreter(), eqn)),
          m_filename(filename)
    {
    }
 
    const LibUtilities::EquationSharedPtr &GetEquation() const override
    {
        return m_notDefinedCondition;
    }
 
    LibUtilities::EquationSharedPtr m_notDefinedCondition;
    std::string m_filename;
};
 
typedef std::map<int, CompositeSharedPtr> BoundaryRegion;
typedef std::shared_ptr<BoundaryRegion> BoundaryRegionShPtr;
typedef std::shared_ptr<const BoundaryRegion> ConstBoundaryRegionShPtr;
typedef std::map<int, BoundaryRegionShPtr> BoundaryRegionCollection;
 
typedef std::shared_ptr<BoundaryConditionBase> BoundaryConditionShPtr;
typedef std::shared_ptr<DirichletBoundaryCondition> DirichletBCShPtr;
typedef std::shared_ptr<NeumannBoundaryCondition> NeumannBCShPtr;
typedef std::shared_ptr<RobinBoundaryCondition> RobinBCShPtr;
 
typedef std::map<std::string, BoundaryConditionShPtr> BoundaryConditionMap;
typedef std::shared_ptr<BoundaryConditionMap> BoundaryConditionMapShPtr;
typedef std::map<int, BoundaryConditionMapShPtr> BoundaryConditionCollection;
 
const static Array<OneD, BoundaryConditionShPtr>
    NullBoundaryConditionShPtrArray;
 
class BoundaryConditions
{
public:
    SPATIAL_DOMAINS_EXPORT BoundaryConditions(
        const LibUtilities::SessionReaderSharedPtr &pSession,
        const MeshGraphSharedPtr &meshGraph);
 
    SPATIAL_DOMAINS_EXPORT BoundaryConditions(void)  = default;
    SPATIAL_DOMAINS_EXPORT ~BoundaryConditions(void) = default;
 
    const BoundaryRegionCollection &GetBoundaryRegions(void) const
    {
        return m_boundaryRegions;
    }
 
    void AddBoundaryRegions(const int regionID, BoundaryRegionShPtr &bRegion)
    {
        m_boundaryRegions[regionID] = bRegion;
    }
 
    const BoundaryConditionCollection &GetBoundaryConditions(void) const
    {
        return m_boundaryConditions;
    }
 
    void AddBoundaryConditions(const int regionID,
                               BoundaryConditionMapShPtr &bCond)
    {
        m_boundaryConditions[regionID] = bCond;
    }
 
    const std::string GetVariable(unsigned int indx)
    {
        return m_session->GetVariable(indx);
    }
 
    std::map<int, LibUtilities::CommSharedPtr> GetBoundaryCommunicators() const
    {
        return m_boundaryCommunicators;
    }
 
    const std::map<int, std::string> &GetBoundaryLabels(void) const
    {
        return m_boundaryLabels;
    }
 
protected:
    /// The mesh graph to use for referencing geometry info.
    MeshGraphSharedPtr m_meshGraph;
    LibUtilities::SessionReaderSharedPtr m_session;
 
    BoundaryRegionCollection m_boundaryRegions;
    std::map<int, std::string> m_boundaryLabels;
    BoundaryConditionCollection m_boundaryConditions;
    std::map<int, LibUtilities::CommSharedPtr> m_boundaryCommunicators;
 
private:
    /// Read segments (and general MeshGraph) given TiXmlDocument.
    void Read(TiXmlElement *conditions);
    void ReadBoundaryRegions(TiXmlElement *regions);
    void ReadBoundaryConditions(TiXmlElement *conditions);
    void CreateBoundaryComms();
};
 
typedef std::shared_ptr<BoundaryConditions> BoundaryConditionsSharedPtr;
} // namespace SpatialDomains
} // namespace Nektar
 
#endif // NEKTAR_SPATIALDOMAINS_BOUNDARYCONDITIONS_H