Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
DisContField3D.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File DisContField3D.h
4 //
5 // For more information, please see: http://www.nektar.info
6 //
7 // The MIT License
8 //
9 // Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10 // Department of Aeronautics, Imperial College London (UK), and Scientific
11 // Computing and Imaging Institute, University of Utah (USA).
12 //
13 // License for the specific language governing rights and limitations under
14 // Permission is hereby granted, free of charge, to any person obtaining a
15 // copy of this software and associated documentation files (the "Software"),
16 // to deal in the Software without restriction, including without limitation
17 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 // and/or sell copies of the Software, and to permit persons to whom the
19 // Software is furnished to do so, subject to the following conditions:
20 //
21 // The above copyright notice and this permission notice shall be included
22 // in all copies or substantial portions of the Software.
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 // DEALINGS IN THE SOFTWARE.
31 //
32 // Description: Field definition in three-dimensions for a discontinuous
33 // LDG-H expansion
34 //
35 ///////////////////////////////////////////////////////////////////////////////
36 
37 #ifndef NEKTAR_LIBS_MULTIREGIONS_DISCONTFIELD3D_H
38 #define NEKTAR_LIBS_MULTIREGIONS_DISCONTFIELD3D_H
39 
42 #include <MultiRegions/ExpList3D.h>
47 
48 namespace Nektar
49 {
50  namespace MultiRegions
51  {
52  class AssemblyMapDG;
53 
54 
55  class DisContField3D : public ExpList3D
56  {
57  public:
59 
63  const std::string &variable,
64  const bool SetUpJustDG = true);
65 
67  const DisContField3D &In,
69  const std::string &variable,
70  const bool SetUpJustDG = false);
71 
72  /// Constructs a global discontinuous field based on another
73  /// discontinuous field.
74  MULTI_REGIONS_EXPORT DisContField3D(const DisContField3D &In);
75 
76  /// Destructor.
78 
80  const GlobalLinSysKey &mkey);
81 
82 
84  Array<OneD, NekDouble> &outarray);
85 
87  {
88  return m_leftAdjacentFaces[cnt];
89  }
90 
91 
92  protected:
93  /**
94  * @brief An object which contains the discretised boundary
95  * conditions.
96  *
97  * It is an array of size equal to the number of boundary regions
98  * and consists of entries of the type MultiRegions#ExpList2D. Every
99  * entry corresponds to the two-dimensional spectral/hp expansion on
100  * a single boundary region. The values of the boundary conditions
101  * are stored as the coefficients of the two-dimensional expansion.
102  */
104 
105  /**
106  * @brief An array which contains the information about
107  * the boundary condition on the different boundary regions.
108  */
110 
114  /// Map of local trace (the points at the face of the
115  /// element) to the trace space discretisation
117 
118  /**
119  * @brief A set storing the global IDs of any boundary faces.
120  */
121  std::set<int> m_boundaryFaces;
122 
123  /**
124  * @brief A map which identifies pairs of periodic faces.
125  */
127 
128  /**
129  * @brief A map which identifies groups of periodic edges.
130  */
132 
133  /**
134  * @brief A map which identifies groups of periodic vertices.
135  */
137 
138  /*
139  * @brief A map identifying which faces are left- and right-adjacent
140  * for DG.
141  */
142  std::vector<bool> m_leftAdjacentFaces;
143 
144  /**
145  * @brief A vector indicating degress of freedom which need to be
146  * copied from forwards to backwards space in case of a periodic
147  * boundary condition.
148  */
149  std::vector<int> m_periodicFwdCopy;
150  std::vector<int> m_periodicBwdCopy;
151 
152  void SetUpDG(const std::string = "DefaultVar");
153  bool SameTypeOfBoundaryConditions(const DisContField3D &In);
155  const SpatialDomains::MeshGraphSharedPtr &graph3D,
157  const std::string &variable);
158  void FindPeriodicFaces(
160  const std::string &variable);
161 
162  bool IsLeftAdjacentFace(const int n, const int e);
163 
164  virtual void v_GetFwdBwdTracePhys(
166  Array<OneD,NekDouble> &Bwd);
167  virtual void v_GetFwdBwdTracePhys(
168  const Array<OneD,const NekDouble> &field,
171  virtual const std::vector<bool> &v_GetLeftAdjacentFaces(void) const;
172  virtual void v_ExtractTracePhys(
173  Array<OneD, NekDouble> &outarray);
174  virtual void v_ExtractTracePhys(
175  const Array<OneD, const NekDouble> &inarray,
176  Array<OneD, NekDouble> &outarray);
177  virtual void v_AddTraceIntegral(
179  Array<OneD, NekDouble> &outarray);
180  virtual void v_AddFwdBwdTraceIntegral(
181  const Array<OneD, const NekDouble> &Fwd,
182  const Array<OneD, const NekDouble> &Bwd,
183  Array<OneD, NekDouble> &outarray);
184  virtual void v_HelmSolve(
185  const Array<OneD, const NekDouble> &inarray,
186  Array<OneD, NekDouble> &outarray,
187  const FlagList &flags,
188  const StdRegions::ConstFactorMap &factors,
189  const StdRegions::VarCoeffMap &varcoeff,
190  const Array<OneD, const NekDouble> &dirForcing);
191  virtual void v_GeneralMatrixOp(
192  const GlobalMatrixKey &gkey,
193  const Array<OneD,const NekDouble> &inarray,
194  Array<OneD, NekDouble> &outarray,
195  CoeffState coeffstate = eLocal);
196  virtual void v_GetBoundaryToElmtMap(
197  Array<OneD, int> &ElmtID,
198  Array<OneD, int> &FaceID);
199  virtual void v_GetBndElmtExpansion(int i,
200  boost::shared_ptr<ExpList> &result);
201  virtual void v_Reset();
202 
203  /*
204  * @brief Obtain a copy of the periodic edges and vertices for this
205  * field.
206  */
207  virtual void v_GetPeriodicEntities(
208  PeriodicMap &periodicVerts,
209  PeriodicMap &periodicEdges,
210  PeriodicMap &periodicFaces)
211  {
212  periodicVerts = m_periodicVerts;
213  periodicEdges = m_periodicEdges;
214  periodicFaces = m_periodicFaces;
215  }
216 
218  {
219  if(m_trace == NullExpListSharedPtr)
220  {
221  SetUpDG();
222  }
223 
224  return m_trace;
225  }
226 
228  {
229  return m_traceMap;
230  }
231 
234  {
235  return m_bndCondExpansions;
236  }
237 
238  virtual const
241  {
242  return m_bndConditions;
243  }
244 
247  {
248  return m_bndCondExpansions[i];
249  }
250 
253  {
254  return m_bndConditions;
255  }
256 
257  virtual void v_EvaluateBoundaryConditions(
258  const NekDouble time = 0.0,
259  const std::string varName = "",
262 
263  virtual std::map<int, RobinBCInfoSharedPtr> v_GetRobinBCInfo();
264  };
265 
266  typedef boost::shared_ptr<DisContField3D> DisContField3DSharedPtr;
267  } //end of namespace
268 } //end of namespace
269 
270 #endif // MULTIERGIONS_DISCONTFIELD3D_H
boost::shared_ptr< AssemblyMapDG > AssemblyMapDGSharedPtr
Definition: AssemblyMapDG.h:49
virtual const Array< OneD, const MultiRegions::ExpListSharedPtr > & v_GetBndCondExpansions()
GlobalLinSysSharedPtr GetGlobalBndLinSys(const GlobalLinSysKey &mkey)
virtual void v_ExtractTracePhys(Array< OneD, NekDouble > &outarray)
Array< OneD, MultiRegions::ExpListSharedPtr > m_bndCondExpansions
An object which contains the discretised boundary conditions.
Local coefficients.
virtual void v_GetBndElmtExpansion(int i, boost::shared_ptr< ExpList > &result)
static ExpListSharedPtr NullExpListSharedPtr
Definition: ExpList.h:1395
bool IsLeftAdjacentFace(const int n, const int e)
#define MULTI_REGIONS_EXPORT
std::set< int > m_boundaryFaces
A set storing the global IDs of any boundary faces.
virtual Array< OneD, SpatialDomains::BoundaryConditionShPtr > & v_UpdateBndConditions()
PeriodicMap m_periodicFaces
A map which identifies pairs of periodic faces.
virtual void v_GetFwdBwdTracePhys(Array< OneD, NekDouble > &Fwd, Array< OneD, NekDouble > &Bwd)
This method extracts the "forward" and "backward" trace data from the array field and puts the data i...
std::map< ConstFactorType, NekDouble > ConstFactorMap
Definition: StdRegions.hpp:251
void EvaluateHDGPostProcessing(Array< OneD, NekDouble > &outarray)
Evaluate HDG post-processing to increase polynomial order of solution.
virtual void v_AddFwdBwdTraceIntegral(const Array< OneD, const NekDouble > &Fwd, const Array< OneD, const NekDouble > &Bwd, Array< OneD, NekDouble > &outarray)
Add trace contributions into elemental coefficient spaces.
virtual void v_EvaluateBoundaryConditions(const NekDouble time=0.0, const std::string varName="", const NekDouble x2_in=NekConstants::kNekUnsetDouble, const NekDouble x3_in=NekConstants::kNekUnsetDouble)
This function evaluates the boundary conditions at a certain time-level.
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:51
virtual MultiRegions::ExpListSharedPtr & v_UpdateBndCondExpansion(int i)
boost::shared_ptr< LocTraceToTraceMap > LocTraceToTraceMapSharedPtr
virtual AssemblyMapDGSharedPtr & v_GetTraceMap()
void FindPeriodicFaces(const SpatialDomains::BoundaryConditions &bcs, const std::string &variable)
Determine the periodic faces, edges and vertices for the given graph.
virtual std::map< int, RobinBCInfoSharedPtr > v_GetRobinBCInfo()
std::vector< int > m_periodicFwdCopy
A vector indicating degress of freedom which need to be copied from forwards to backwards space in ca...
DisContField3D()
Default constructor.
virtual const std::vector< bool > & v_GetLeftAdjacentFaces(void) const
std::map< StdRegions::VarCoeffType, Array< OneD, NekDouble > > VarCoeffMap
Definition: StdRegions.hpp:226
LocTraceToTraceMapSharedPtr m_locTraceToTraceMap
Map of local trace (the points at the face of the element) to the trace space discretisation.
boost::shared_ptr< ExpList > ExpListSharedPtr
Shared pointer to an ExpList object.
boost::shared_ptr< GlobalLinSysMap > GlobalLinSysMapShPtr
Pointer to a GlobalLinSys/key map.
Definition: GlobalLinSys.h:59
void GenerateBoundaryConditionExpansion(const SpatialDomains::MeshGraphSharedPtr &graph3D, const SpatialDomains::BoundaryConditions &bcs, const std::string &variable)
virtual void v_GeneralMatrixOp(const GlobalMatrixKey &gkey, const Array< OneD, const NekDouble > &inarray, Array< OneD, NekDouble > &outarray, CoeffState coeffstate=eLocal)
Calculates the result of the multiplication of a global matrix of type specified by mkey with a vecto...
double NekDouble
void SetUpDG(const std::string="DefaultVar")
Set up all DG member variables and maps.
bool SameTypeOfBoundaryConditions(const DisContField3D &In)
Defines a list of flags.
boost::shared_ptr< DisContField3D > DisContField3DSharedPtr
std::map< int, std::vector< PeriodicEntity > > PeriodicMap
static const NekDouble kNekUnsetDouble
Describe a linear system.
Describes a matrix with ordering defined by a local to global map.
virtual ExpListSharedPtr & v_GetTrace()
PeriodicMap m_periodicVerts
A map which identifies groups of periodic vertices.
virtual void v_HelmSolve(const Array< OneD, const NekDouble > &inarray, Array< OneD, NekDouble > &outarray, const FlagList &flags, const StdRegions::ConstFactorMap &factors, const StdRegions::VarCoeffMap &varcoeff, const Array< OneD, const NekDouble > &dirForcing)
virtual void v_GetBoundaryToElmtMap(Array< OneD, int > &ElmtID, Array< OneD, int > &FaceID)
Set up a list of elemeent IDs and edge IDs that link to the boundary conditions.
virtual void v_Reset()
Reset this field, so that geometry information can be updated.
Array< OneD, SpatialDomains::BoundaryConditionShPtr > m_bndConditions
An array which contains the information about the boundary condition on the different boundary region...
Abstraction of a three-dimensional multi-elemental expansion which is merely a collection of local ex...
Definition: ExpList3D.h:49
boost::shared_ptr< GlobalLinSys > GlobalLinSysSharedPtr
Pointer to a GlobalLinSys object.
Definition: GlobalLinSys.h:52
virtual const Array< OneD, const SpatialDomains::BoundaryConditionShPtr > & v_GetBndConditions()
virtual void v_GetPeriodicEntities(PeriodicMap &periodicVerts, PeriodicMap &periodicEdges, PeriodicMap &periodicFaces)
boost::shared_ptr< MeshGraph > MeshGraphSharedPtr
Definition: MeshGraph.h:442
virtual void v_AddTraceIntegral(const Array< OneD, const NekDouble > &Fn, Array< OneD, NekDouble > &outarray)
Add trace contributions into elemental coefficient spaces.
PeriodicMap m_periodicEdges
A map which identifies groups of periodic edges.