This processing module calculates the vorticity and adds it as an extra-field to the output file. More...

#include <ProcessVorticity.h>

Inheritance diagram for Nektar::FieldUtils::ProcessVorticity:

Public Member Functions
	ProcessVorticity (FieldSharedPtr f)

virtual	~ProcessVorticity ()

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 ConfigOption &	GetConfigOption (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< Module >	create (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

void	GetVelocity (Array< OneD, Array< OneD, NekDouble >> &vel, int totfields, int strip=0)

Protected Member Functions inherited from Nektar::FieldUtils::Module
	Module ()

Private Attributes
int	m_spacedim

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, ConfigOption >	m_config
	List of configuration values. More...

std::set< std::string >	m_allowedFiles
	List of allowed file formats. More...

Detailed Description

This processing module calculates the vorticity and adds it as an extra-field to the output file.

Definition at line 48 of file ProcessVorticity.h.

Constructor & Destructor Documentation

◆ ProcessVorticity()

Nektar::FieldUtils::ProcessVorticity::ProcessVorticity ( FieldSharedPtr f )

Definition at line 57 of file ProcessVorticity.cpp.

                                                    : ProcessModule(f)
 {
 }

◆ ~ProcessVorticity()

Nektar::FieldUtils::ProcessVorticity::~ProcessVorticity ( )

virtual

Definition at line 61 of file ProcessVorticity.cpp.

62 {

63 }

Member Function Documentation

◆ create()

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

inlinestatic

Creates an instance of this class.

Definition at line 52 of file ProcessVorticity.h.

     {
         return MemoryManager<ProcessVorticity>::AllocateSharedPtr(f);
     }

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

◆ GetVelocity()

void Nektar::FieldUtils::ProcessVorticity::GetVelocity	(	Array< OneD, Array< OneD, NekDouble >> &	vel,
		int	totfields,
		int	strip = `0`
	)

protected

Definition at line 224 of file ProcessVorticity.cpp.

 {
     int npoints = m_f->m_exp[0]->GetNpoints();
     if (boost::iequals(m_f->m_variables[0], "u"))
     {
         // IncNavierStokesSolver
         for (int i = 0; i < m_spacedim; ++i)
         {
             vel[i] = Array<OneD, NekDouble>(npoints);
             Vmath::Vcopy(npoints, m_f->m_exp[strip * totfields + i]->GetPhys(),
                          1, vel[i], 1);
         }
     }
     else if (boost::iequals(m_f->m_variables[0], "rho") &&
              boost::iequals(m_f->m_variables[1], "rhou"))
     {
         // CompressibleFlowSolver
         for (int i = 0; i < m_spacedim; ++i)
         {
             vel[i] = Array<OneD, NekDouble>(npoints);
             Vmath::Vdiv(
                 npoints, m_f->m_exp[strip * totfields + i + 1]->GetPhys(), 1,
                 m_f->m_exp[strip * totfields + 0]->GetPhys(), 1, vel[i], 1);
         }
     }
     else
     {
         // Unknown
         ASSERTL0(false, "Could not identify velocity for ProcessVorticity");
     }
 }

References ASSERTL0, Nektar::FieldUtils::Module::m_f, m_spacedim, Vmath::Vcopy(), and Vmath::Vdiv().

Referenced by v_Process().

◆ v_GetModuleDescription()

virtual std::string Nektar::FieldUtils::ProcessVorticity::v_GetModuleDescription ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 70 of file ProcessVorticity.h.

     {
         return "Calculating vorticity";
     }

◆ v_GetModuleName()

virtual std::string Nektar::FieldUtils::ProcessVorticity::v_GetModuleName ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 65 of file ProcessVorticity.h.

     {
         return "ProcessVorticity";
     }

◆ v_GetModulePriority()

virtual ModulePriority Nektar::FieldUtils::ProcessVorticity::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 75 of file ProcessVorticity.h.

     {
         return eModifyExp;
     }

References Nektar::FieldUtils::eModifyExp.

◆ v_Process()

void Nektar::FieldUtils::ProcessVorticity::v_Process ( po::variables_map & vm )

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 65 of file ProcessVorticity.cpp.

 {
     m_f->SetUpExp(vm);
  
     int i, s;
     int expdim = m_f->m_graph->GetMeshDimension();
     m_spacedim = expdim;
     if ((m_f->m_numHomogeneousDir) == 1 || (m_f->m_numHomogeneousDir) == 2)
     {
         m_spacedim = 3;
     }
     int nfields = m_f->m_variables.size();
     ASSERTL0(m_spacedim != 1,
              "Error: Vorticity for a 1D problem cannot be computed");
     int addfields = (m_spacedim == 2) ? 1 : 3;
  
     // Append field names
     if (addfields == 1)
     {
         m_f->m_variables.push_back("W_z");
     }
     else
     {
         m_f->m_variables.push_back("W_x");
         m_f->m_variables.push_back("W_y");
         m_f->m_variables.push_back("W_z");
     }
  
     // Skip in case of empty partition
     if (m_f->m_exp[0]->GetNumElmts() == 0)
     {
         return;
     }
     int npoints = m_f->m_exp[0]->GetNpoints();
     Array<OneD, Array<OneD, NekDouble>> grad(m_spacedim * m_spacedim);
     Array<OneD, Array<OneD, NekDouble>> outfield(addfields);
  
     int nstrips;
  
     m_f->m_session->LoadParameter("Strip_Z", nstrips, 1);
  
     for (i = 0; i < m_spacedim * m_spacedim; ++i)
     {
         grad[i] = Array<OneD, NekDouble>(npoints);
     }
  
     for (i = 0; i < addfields; ++i)
     {
         outfield[i] = Array<OneD, NekDouble>(npoints);
     }
  
     Array<OneD, Array<OneD, NekDouble>> tmp(m_spacedim);
     for (int i = 0; i < m_spacedim; i++)
     {
         tmp[i] = Array<OneD, NekDouble>(npoints);
     }
  
     // add in new fields
     for (s = 0; s < nstrips; ++s)
     {
         for (i = 0; i < addfields; ++i)
         {
             MultiRegions::ExpListSharedPtr Exp =
                 m_f->AppendExpList(m_f->m_numHomogeneousDir);
             m_f->m_exp.insert(m_f->m_exp.begin() + s * (nfields + addfields) +
                                   nfields + i,
                               Exp);
         }
     }
  
     // Get mapping
     GlobalMapping::MappingSharedPtr mapping = ProcessMapping::GetMapping(m_f);
  
     for (s = 0; s < nstrips; ++s) // homogeneous strip varient
     {
         // Get velocity and convert to Cartesian system,
         //      if it is still in transformed system
         Array<OneD, Array<OneD, NekDouble>> vel(m_spacedim);
         GetVelocity(vel, nfields + addfields, s);
         if (m_f->m_fieldMetaDataMap.count("MappingCartesianVel"))
         {
             if (m_f->m_fieldMetaDataMap["MappingCartesianVel"] == "False")
             {
                 // Initialize arrays and copy velocity
                 if (m_f->m_exp[0]->GetWaveSpace())
                 {
                     for (int i = 0; i < m_spacedim; ++i)
                     {
                         m_f->m_exp[0]->HomogeneousBwdTrans(npoints, vel[i],
                                                            vel[i]);
                     }
                 }
                 // Convert velocity to cartesian system
                 mapping->ContravarToCartesian(vel, vel);
                 // Convert back to wavespace if necessary
                 if (m_f->m_exp[0]->GetWaveSpace())
                 {
                     for (int i = 0; i < m_spacedim; ++i)
                     {
                         m_f->m_exp[0]->HomogeneousFwdTrans(npoints, vel[i],
                                                            vel[i]);
                     }
                 }
             }
         }
  
         // Calculate Gradient & Vorticity
         if (m_spacedim == 2)
         {
             for (i = 0; i < m_spacedim; ++i)
             {
                 m_f->m_exp[s * nfields + i]->PhysDeriv(vel[i], tmp[0], tmp[1]);
                 mapping->CovarToCartesian(tmp, tmp);
                 for (int j = 0; j < m_spacedim; j++)
                 {
                     Vmath::Vcopy(npoints, tmp[j], 1, grad[i * m_spacedim + j],
                                  1);
                 }
             }
             // W_z = Vx - Uy
             Vmath::Vsub(npoints, grad[1 * m_spacedim + 0], 1,
                         grad[0 * m_spacedim + 1], 1, outfield[0], 1);
         }
         else
         {
             for (i = 0; i < m_spacedim; ++i)
             {
                 m_f->m_exp[s * nfields + i]->PhysDeriv(vel[i], tmp[0], tmp[1],
                                                        tmp[2]);
                 mapping->CovarToCartesian(tmp, tmp);
                 for (int j = 0; j < m_spacedim; j++)
                 {
                     Vmath::Vcopy(npoints, tmp[j], 1, grad[i * m_spacedim + j],
                                  1);
                 }
             }
  
             // W_x = Wy - Vz
             Vmath::Vsub(npoints, grad[2 * m_spacedim + 1], 1,
                         grad[1 * m_spacedim + 2], 1, outfield[0], 1);
             // W_y = Uz - Wx
             Vmath::Vsub(npoints, grad[0 * m_spacedim + 2], 1,
                         grad[2 * m_spacedim + 0], 1, outfield[1], 1);
             // W_z = Vx - Uy
             Vmath::Vsub(npoints, grad[1 * m_spacedim + 0], 1,
                         grad[0 * m_spacedim + 1], 1, outfield[2], 1);
         }
  
         for (i = 0; i < addfields; ++i)
         {
             int fid = s * (nfields + addfields) + nfields + i;
             Vmath::Vcopy(npoints, outfield[i], 1, m_f->m_exp[fid]->UpdatePhys(),
                          1);
             m_f->m_exp[fid]->FwdTransLocalElmt(outfield[i],
                                                m_f->m_exp[fid]->UpdateCoeffs());
         }
     }
 }

References ASSERTL0, Nektar::FieldUtils::ProcessMapping::GetMapping(), GetVelocity(), Nektar::FieldUtils::Module::m_f, m_spacedim, Nektar::GlobalMapping::MappingSharedPtr, Vmath::Vcopy(), and Vmath::Vsub().

Member Data Documentation

◆ className

ModuleKey Nektar::FieldUtils::ProcessVorticity::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "vorticity"), ProcessVorticity::create,
        "Computes vorticity field.")

Definition at line 56 of file ProcessVorticity.h.

◆ m_spacedim

int Nektar::FieldUtils::ProcessVorticity::m_spacedim

private

Definition at line 85 of file ProcessVorticity.h.

Referenced by GetVelocity(), and v_Process().

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ProcessVorticity()

◆ ~ProcessVorticity()

Member Function Documentation

◆ create()

◆ GetVelocity()

◆ v_GetModuleDescription()

◆ v_GetModuleName()

◆ v_GetModulePriority()

◆ v_Process()

Member Data Documentation

◆ className

◆ m_spacedim