Nektar++
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
Nektar::FieldUtils::ProcessJacobianEnergy Class Reference

This processing module scales the input fld file. More...

#include <ProcessJacobianEnergy.h>

Inheritance diagram for Nektar::FieldUtils::ProcessJacobianEnergy:
[legend]

Public Member Functions

 ProcessJacobianEnergy (FieldSharedPtr f)
 
virtual ~ProcessJacobianEnergy ()
 
- Public Member Functions inherited from Nektar::FieldUtils::ProcessModule
 ProcessModule ()
 
 ProcessModule (FieldSharedPtr p_f)
 
- Public Member Functions inherited from Nektar::FieldUtils::Module
FIELD_UTILS_EXPORT Module (FieldSharedPtr p_f)
 
virtual ~Module ()=default
 
void Process (po::variables_map &vm)
 
std::string GetModuleName ()
 
std::string GetModuleDescription ()
 
const ConfigOptionGetConfigOption (const std::string &key) const
 
ModulePriority GetModulePriority ()
 
FIELD_UTILS_EXPORT void RegisterConfig (std::string key, std::string value="")
 Register a configuration option with a module. More...
 
FIELD_UTILS_EXPORT void PrintConfig ()
 Print out all configuration options for a module. More...
 
FIELD_UTILS_EXPORT void SetDefaults ()
 Sets default configuration options for those which have not been set. More...
 
FIELD_UTILS_EXPORT void AddFile (std::string fileType, std::string fileName)
 
FIELD_UTILS_EXPORT void EvaluateTriFieldAtEquiSpacedPts (LocalRegions::ExpansionSharedPtr &exp, const Array< OneD, const NekDouble > &infield, Array< OneD, NekDouble > &outfield)
 

Static Public Member Functions

static std::shared_ptr< Modulecreate (FieldSharedPtr f)
 Creates an instance of this class. More...
 

Static Public Attributes

static ModuleKey className
 

Protected Member Functions

virtual void v_Process (po::variables_map &vm) override
 Write mesh to output file. More...
 
virtual std::string v_GetModuleName () override
 
virtual std::string v_GetModuleDescription () override
 
virtual ModulePriority v_GetModulePriority () override
 
- Protected Member Functions inherited from Nektar::FieldUtils::Module
 Module ()
 

Additional Inherited Members

- Public Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr m_f
 Field object. More...
 
- Protected Attributes inherited from Nektar::FieldUtils::Module
std::map< std::string, ConfigOptionm_config
 List of configuration values. More...
 
std::set< std::string > m_allowedFiles
 List of allowed file formats. More...
 

Detailed Description

This processing module scales the input fld file.

Definition at line 46 of file ProcessJacobianEnergy.h.

Constructor & Destructor Documentation

◆ ProcessJacobianEnergy()

Nektar::FieldUtils::ProcessJacobianEnergy::ProcessJacobianEnergy ( FieldSharedPtr  f)

Definition at line 56 of file ProcessJacobianEnergy.cpp.

57  : ProcessModule(f)
58 {
59  m_config["topmodes"] =
60  ConfigOption(false, "1", "how many top modes to keep ");
61 }
std::map< std::string, ConfigOption > m_config
List of configuration values.
Definition: Module.h:263

References Nektar::FieldUtils::Module::m_config.

◆ ~ProcessJacobianEnergy()

Nektar::FieldUtils::ProcessJacobianEnergy::~ProcessJacobianEnergy ( )
virtual

Definition at line 63 of file ProcessJacobianEnergy.cpp.

64 {
65 }

Member Function Documentation

◆ create()

static std::shared_ptr<Module> Nektar::FieldUtils::ProcessJacobianEnergy::create ( FieldSharedPtr  f)
inlinestatic

Creates an instance of this class.

Definition at line 50 of file ProcessJacobianEnergy.h.

51  {
53  }
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr().

◆ v_GetModuleDescription()

virtual std::string Nektar::FieldUtils::ProcessJacobianEnergy::v_GetModuleDescription ( )
inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 68 of file ProcessJacobianEnergy.h.

69  {
70  return "Processing Jacobian";
71  }

◆ v_GetModuleName()

virtual std::string Nektar::FieldUtils::ProcessJacobianEnergy::v_GetModuleName ( )
inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 63 of file ProcessJacobianEnergy.h.

64  {
65  return "ProcessJacobianEnergy";
66  }

◆ v_GetModulePriority()

virtual ModulePriority Nektar::FieldUtils::ProcessJacobianEnergy::v_GetModulePriority ( )
inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 73 of file ProcessJacobianEnergy.h.

74  {
75  return eModifyExp;
76  }

References Nektar::FieldUtils::eModifyExp.

◆ v_Process()

void Nektar::FieldUtils::ProcessJacobianEnergy::v_Process ( po::variables_map &  vm)
overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 67 of file ProcessJacobianEnergy.cpp.

68 {
69  m_f->SetUpExp(vm);
70 
71  int nfields = m_f->m_variables.size();
72  m_f->m_variables.push_back("jacenergy");
73  // Skip in case of empty partition
74  if (m_f->m_exp[0]->GetNumElmts() == 0)
75  {
76  return;
77  }
78 
79  int NumHomogeneousDir = m_f->m_numHomogeneousDir;
81 
82  if (nfields)
83  {
84  m_f->m_exp.resize(nfields + 1);
85  exp = m_f->AppendExpList(NumHomogeneousDir);
86  m_f->m_exp[nfields] = exp;
87  }
88  else
89  {
90  exp = m_f->m_exp[0];
91  }
92 
93  Array<OneD, NekDouble> phys = exp->UpdatePhys();
94  Array<OneD, NekDouble> coeffs = exp->UpdateCoeffs();
95  Array<OneD, NekDouble> tmp;
96 
97  for (int i = 0; i < exp->GetExpSize(); ++i)
98  {
99  // copy Jacobian into field
100  StdRegions::StdExpansionSharedPtr Elmt = exp->GetExp(i);
101 
102  const StdRegions::StdExpansion *sep = &(*Elmt);
103  const LocalRegions::Expansion *lep =
104  dynamic_cast<const LocalRegions::Expansion *>(sep);
105 
106  int nquad = Elmt->GetTotPoints();
107  int coeffoffset = exp->GetCoeff_Offset(i);
108  Array<OneD, const NekDouble> Jac =
109  lep->GetMetricInfo()->GetJac(Elmt->GetPointsKeys());
110  if (lep->GetMetricInfo()->GetGtype() == SpatialDomains::eRegular)
111  {
112  Vmath::Fill(nquad, Jac[0], phys, 1);
113  }
114  else
115  {
116  Vmath::Vcopy(nquad, Jac, 1, phys, 1);
117  }
118 
119  if (lep->GetMetricInfo()->GetGtype() == SpatialDomains::eDeformed)
120  {
121  NekDouble jacmax = Vmath::Vmax(nquad, Jac, 1);
122  NekDouble jacmin = Vmath::Vmin(nquad, Jac, 1);
123 
124  NekDouble jacmeasure = jacmax / jacmin - 1.0;
125  Vmath::Fill(nquad, jacmeasure, phys, 1);
126  }
127  else
128  {
129  Vmath::Fill(nquad, 0.0, phys, 1);
130  }
131 
132  Elmt->FwdTrans(phys, tmp = coeffs + coeffoffset);
133  }
134  exp->BwdTrans(coeffs, phys);
135 }
FieldSharedPtr m_f
Field object.
Definition: Module.h:234
std::shared_ptr< ExpList > ExpListSharedPtr
Shared pointer to an ExpList object.
@ eRegular
Geometry is straight-sided with constant geometric factors.
@ eDeformed
Geometry is curved or has non-constant factors.
std::shared_ptr< StdExpansion > StdExpansionSharedPtr
double NekDouble
T Vmin(int n, const T *x, const int incx)
Return the minimum element in x - called vmin to avoid conflict with min.
Definition: Vmath.cpp:1050
void Fill(int n, const T alpha, T *x, const int incx)
Fill a vector with a constant value.
Definition: Vmath.cpp:45
T Vmax(int n, const T *x, const int incx)
Return the maximum element in x – called vmax to avoid conflict with max.
Definition: Vmath.cpp:945
void Vcopy(int n, const T *x, const int incx, T *y, const int incy)
Definition: Vmath.cpp:1255

References Nektar::SpatialDomains::eDeformed, Nektar::SpatialDomains::eRegular, Vmath::Fill(), Nektar::LocalRegions::Expansion::GetMetricInfo(), Nektar::StdRegions::StdExpansion::GetTotPoints(), Nektar::FieldUtils::Module::m_f, Vmath::Vcopy(), Vmath::Vmax(), and Vmath::Vmin().

Member Data Documentation

◆ className

ModuleKey Nektar::FieldUtils::ProcessJacobianEnergy::className
static
Initial value:
=
ModuleKey(eProcessModule, "jacobianenergy"),
"Show high frequency energy of Jacobian.")
static std::shared_ptr< Module > create(FieldSharedPtr f)
Creates an instance of this class.
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, std::string pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:198
std::pair< ModuleType, std::string > ModuleKey
Definition: Module.h:317
ModuleFactory & GetModuleFactory()
Definition: Module.cpp:49

Definition at line 54 of file ProcessJacobianEnergy.h.