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

#include <ProcessGrad.h>

Inheritance diagram for Nektar::FieldUtils::ProcessGrad:

Public Member Functions
	ProcessGrad (FieldSharedPtr f)

	~ProcessGrad () override

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 ()

std::vector< ModuleKey >	GetModulePrerequisites ()

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
void	v_Process (po::variables_map &vm) override
	Write mesh to output file. More...

std::string	v_GetModuleName () override

std::string	v_GetModuleDescription () override

ModulePriority	v_GetModulePriority () override

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

virtual void	v_Process (po::variables_map &vm)

virtual std::string	v_GetModuleName ()

virtual std::string	v_GetModuleDescription ()

virtual ModulePriority	v_GetModulePriority ()

virtual std::vector< ModuleKey >	v_GetModulePrerequisites ()

Private Member Functions
void	ParserOptions (std::set< int > &variables, std::set< int > &directions)

void	ProcessCartesianFld (Array< OneD, Array< OneD, NekDouble > > &grad)

void	ProcessMappingFld (Array< OneD, Array< OneD, NekDouble > > &grad)

Private Attributes
std::set< int >	m_selectedVars

std::set< int >	m_directions

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 gradient and adds it as an extra-field to the output file.

Definition at line 47 of file ProcessGrad.h.

Constructor & Destructor Documentation

◆ ProcessGrad()

Nektar::FieldUtils::ProcessGrad::ProcessGrad ( FieldSharedPtr f )

Definition at line 53 of file ProcessGrad.cpp.

                                         : ProcessModule(f)
{
    m_config["vars"] = ConfigOption(false, "NotSet", "Select variables");
    m_config["dirs"] = ConfigOption(false, "NotSet", "Select directions");
}

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

◆ ~ProcessGrad()

Nektar::FieldUtils::ProcessGrad::~ProcessGrad ( )

override

Definition at line 59 of file ProcessGrad.cpp.

60{

61}

Member Function Documentation

◆ create()

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

inlinestatic

Creates an instance of this class.

Definition at line 51 of file ProcessGrad.h.

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

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

◆ ParserOptions()

void Nektar::FieldUtils::ProcessGrad::ParserOptions	(	std::set< int > &	variables,
		std::set< int > &	directions
	)

private

Definition at line 63 of file ProcessGrad.cpp.

{
    if (m_config["vars"].as<string>().compare("NotSet"))
    {
        ParseUtils::GenerateVariableSet(m_config["vars"].as<string>(),
                                        m_f->m_variables, variables);
    }
    else
    {
        for (int v = 0; v < m_f->m_variables.size(); ++v)
        {
            variables.insert(v);
        }
    }
    vector<string> coords = {"x", "y", "z"};
    int spacedim = m_f->m_numHomogeneousDir + m_f->m_graph->GetMeshDimension();
    coords.resize(spacedim);
    if (m_config["dirs"].as<string>().compare("NotSet"))
    {
        ParseUtils::GenerateVariableSet(m_config["dirs"].as<string>(), coords,
                                        directions);
    }
    else
    {
        for (int d = 0; d < spacedim; ++d)
        {
            directions.insert(d);
        }
    }
}

References Nektar::UnitTests::d(), Nektar::ParseUtils::GenerateVariableSet(), Nektar::FieldUtils::Module::m_config, and Nektar::FieldUtils::Module::m_f.

Referenced by v_Process().

◆ ProcessCartesianFld()

void Nektar::FieldUtils::ProcessGrad::ProcessCartesianFld ( Array< OneD, Array< OneD, NekDouble > > & grad )

private

Definition at line 95 of file ProcessGrad.cpp.

{
    // Calculate Gradient
    int n = 0;
    for (int i : m_selectedVars)
    {
        for (int j : m_directions)
        {
            m_f->m_exp[i]->PhysDeriv(MultiRegions::DirCartesianMap[j],
                                     m_f->m_exp[i]->GetPhys(), grad[n]);
            ++n;
        }
    }
}

References Nektar::MultiRegions::DirCartesianMap, m_directions, Nektar::FieldUtils::Module::m_f, and m_selectedVars.

Referenced by v_Process().

◆ ProcessMappingFld()

void Nektar::FieldUtils::ProcessGrad::ProcessMappingFld ( Array< OneD, Array< OneD, NekDouble > > & grad )

private

Definition at line 110 of file ProcessGrad.cpp.

{
    int expdim   = m_f->m_graph->GetMeshDimension();
    int spacedim = m_f->m_numHomogeneousDir + expdim;
    int nfields  = m_f->m_variables.size();
    bool hasvel = m_selectedVars.size() && (*m_selectedVars.begin() < spacedim);
 
    int npoints = m_f->m_exp[0]->GetNpoints();
 
    Array<OneD, Array<OneD, NekDouble>> tmp(spacedim);
    for (int i = 0; i < spacedim; i++)
    {
        tmp[i] = Array<OneD, NekDouble>(npoints);
    }
 
    // Get mapping
    GlobalMapping::MappingSharedPtr mapping = ProcessMapping::GetMapping(m_f);
 
    // Get velocity and convert to Cartesian system,
    //      if it is still in transformed system
    Array<OneD, Array<OneD, NekDouble>> vel(spacedim);
    if (hasvel && m_f->m_fieldMetaDataMap.count("MappingCartesianVel"))
    {
        if (m_f->m_fieldMetaDataMap["MappingCartesianVel"] == "False")
        {
            // Initialize arrays and copy velocity
            for (int i = 0; i < spacedim; ++i)
            {
                vel[i] = Array<OneD, NekDouble>(npoints);
                if (m_f->m_exp[0]->GetWaveSpace())
                {
                    m_f->m_exp[0]->HomogeneousBwdTrans(
                        npoints, m_f->m_exp[i]->GetPhys(), vel[i]);
                }
                else
                {
                    Vmath::Vcopy(npoints, m_f->m_exp[i]->GetPhys(), 1, vel[i],
                                 1);
                }
            }
            // 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 < spacedim; ++i)
                {
                    m_f->m_exp[0]->HomogeneousFwdTrans(npoints, vel[i], vel[i]);
                }
            }
        }
        else
        {
            for (int i = 0; i < spacedim; ++i)
            {
                vel[i] = Array<OneD, NekDouble>(npoints);
                Vmath::Vcopy(npoints, m_f->m_exp[i]->GetPhys(), 1, vel[i], 1);
            }
        }
    }
    else if (hasvel)
    {
        for (int i = 0; i < spacedim && i < nfields; ++i)
        {
            vel[i] = Array<OneD, NekDouble>(npoints);
            Vmath::Vcopy(npoints, m_f->m_exp[i]->GetPhys(), 1, vel[i], 1);
        }
    }
 
    // Calculate Gradient
    int n = 0;
    for (int i : m_selectedVars)
    {
        for (int j = 0; j < spacedim; ++j)
        {
            if (i < spacedim)
            {
                m_f->m_exp[i]->PhysDeriv(MultiRegions::DirCartesianMap[j],
                                         vel[i], tmp[j]);
            }
            else
            {
                m_f->m_exp[i]->PhysDeriv(MultiRegions::DirCartesianMap[j],
                                         m_f->m_exp[i]->GetPhys(), tmp[j]);
            }
        }
        mapping->CovarToCartesian(tmp, tmp);
        for (int j : m_directions)
        {
            Vmath::Vcopy(npoints, tmp[j], 1, grad[n], 1);
            ++n;
        }
    }
}

References Nektar::MultiRegions::DirCartesianMap, Nektar::FieldUtils::ProcessMapping::GetMapping(), m_directions, Nektar::FieldUtils::Module::m_f, m_selectedVars, Nektar::GlobalMapping::MappingSharedPtr, and Vmath::Vcopy().

Referenced by v_Process().

◆ v_GetModuleDescription()

std::string Nektar::FieldUtils::ProcessGrad::v_GetModuleDescription ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 69 of file ProcessGrad.h.

    {
        return "Calculating gradients";
    }

◆ v_GetModuleName()

std::string Nektar::FieldUtils::ProcessGrad::v_GetModuleName ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 64 of file ProcessGrad.h.

    {
        return "ProcessGrad";
    }

◆ v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessGrad::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 74 of file ProcessGrad.h.

    {
        return eModifyExp;
    }

References Nektar::FieldUtils::eModifyExp.

◆ v_Process()

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

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 205 of file ProcessGrad.cpp.

{
    m_f->SetUpExp(vm);
    ParserOptions(m_selectedVars, m_directions);
 
    int nfields   = m_f->m_variables.size();
    int addfields = m_selectedVars.size() * m_directions.size();
    m_f->m_exp.resize(nfields + addfields);
 
    vector<string> coords = {"x", "y", "z"};
    for (int i : m_selectedVars)
    {
        for (int j : m_directions)
        {
            m_f->m_variables.push_back(m_f->m_variables[i] + "_" + coords[j]);
        }
    }
 
    // 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(addfields);
    for (int i = 0; i < addfields; ++i)
    {
        grad[i] = Array<OneD, NekDouble>(npoints);
    }
 
    if (m_f->m_fieldMetaDataMap.count("MappingType"))
    {
        ProcessMappingFld(grad);
    }
    else
    {
        ProcessCartesianFld(grad);
    }
 
    for (int i = 0; i < addfields; ++i)
    {
        m_f->m_exp[nfields + i] = m_f->AppendExpList(m_f->m_numHomogeneousDir);
 
        Vmath::Vcopy(npoints, grad[i], 1, m_f->m_exp[nfields + i]->UpdatePhys(),
                     1);
        m_f->m_exp[nfields + i]->FwdTransLocalElmt(
            grad[i], m_f->m_exp[nfields + i]->UpdateCoeffs());
    }
}

References m_directions, Nektar::FieldUtils::Module::m_f, m_selectedVars, ParserOptions(), ProcessCartesianFld(), ProcessMappingFld(), and Vmath::Vcopy().

Member Data Documentation

◆ className

ModuleKey Nektar::FieldUtils::ProcessGrad::className

static

Initial value:

= GetModuleFactory().RegisterCreatorFunction(
    ModuleKey(eProcessModule, "gradient"), ProcessGrad::create,
    "Computes gradient of fields.")

Definition at line 55 of file ProcessGrad.h.

◆ m_directions

std::set<int> Nektar::FieldUtils::ProcessGrad::m_directions

private

Definition at line 84 of file ProcessGrad.h.

Referenced by ProcessCartesianFld(), ProcessMappingFld(), and v_Process().

◆ m_selectedVars

std::set<int> Nektar::FieldUtils::ProcessGrad::m_selectedVars

private

Definition at line 83 of file ProcessGrad.h.

Referenced by ProcessCartesianFld(), ProcessMappingFld(), and v_Process().

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ProcessGrad()

◆ ~ProcessGrad()

Member Function Documentation

◆ create()

◆ ParserOptions()

◆ ProcessCartesianFld()

◆ ProcessMappingFld()

◆ v_GetModuleDescription()

◆ v_GetModuleName()

◆ v_GetModulePriority()

◆ v_Process()

Member Data Documentation

◆ className

◆ m_directions

◆ m_selectedVars