Nektar::FieldUtils::ProcessMapping Class Reference

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

#include <ProcessMapping.h>

Inheritance diagram for Nektar::FieldUtils::ProcessMapping:

Public Member Functions
	ProcessMapping (FieldSharedPtr f)
	~ProcessMapping () 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 GlobalMapping::MappingSharedPtr	GetMapping (FieldSharedPtr f)

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

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 scales the input fld file.

Definition at line 48 of file ProcessMapping.h.

Constructor & Destructor Documentation

ProcessMapping()

Nektar::FieldUtils::ProcessMapping::ProcessMapping

(

FieldSharedPtr

f

)

Definition at line 50 of file ProcessMapping.cpp.

                                               : ProcessModule(f)
{
}

~ProcessMapping()

Nektar::FieldUtils::ProcessMapping::~ProcessMapping ( )

override

Definition at line 54 of file ProcessMapping.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 52 of file ProcessMapping.h.

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

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

GetMapping()

GlobalMapping::MappingSharedPtr Nektar::FieldUtils::ProcessMapping::GetMapping ( FieldSharedPtr  f )

static

Definition at line 149 of file ProcessMapping.cpp.

{
    // Create mapping object
    Array<OneD, MultiRegions::ExpListSharedPtr> field(1);
    field[0] = f->m_exp[0];
    GlobalMapping::MappingSharedPtr mapping =
        GlobalMapping::Mapping::Load(f->m_session, field);
 
    // Get time from metadata
    NekDouble time;
    if (f->m_fieldMetaDataMap.count("Time"))
    {
        string s_time = f->m_fieldMetaDataMap["Time"];
        time          = atof(s_time.c_str());
    }
    else
    {
        time = 0.0;
    }
 
    // Get field information
    int npoints  = f->m_exp[0]->GetNpoints();
    int expdim   = f->m_graph->GetMeshDimension();
    int spacedim = expdim + f->m_numHomogeneousDir;
 
    // Declare coordinates storage
    Array<OneD, Array<OneD, NekDouble>> coords_new(3);
    Array<OneD, Array<OneD, NekDouble>> coords_vel(3);
    for (int i = 0; i < 3; i++)
    {
        coords_new[i] = Array<OneD, NekDouble>(npoints);
        coords_vel[i] = Array<OneD, NekDouble>(npoints, 0.0);
    }
 
    string fieldNames[3]    = {"x", "y", "z"};
    string velFieldNames[3] = {"vx", "vy", "vz"};
 
    // Evaluate coordinates and coordinates velocity
    if (f->m_fieldMetaDataMap.count("MappingType"))
    {
        if (f->m_fieldMetaDataMap["MappingType"] == "Expression")
        {
            // Get name of the functions
            string funcName;
            string velFuncName;
            if (f->m_fieldMetaDataMap.count("MappingExpression"))
            {
                funcName = f->m_fieldMetaDataMap["MappingExpression"];
            }
            else
            {
                funcName = "";
            }
            if (f->m_fieldMetaDataMap.count("MappingVelExpression"))
            {
                velFuncName = f->m_fieldMetaDataMap["MappingVelExpression"];
            }
            else
            {
                velFuncName = "";
            }
 
            // Get original coordinates (in case some of them are not changed)
            Array<OneD, Array<OneD, NekDouble>> coords(3);
            for (int i = 0; i < 3; i++)
            {
                coords[i] = Array<OneD, NekDouble>(npoints);
            }
            f->m_exp[0]->GetCoords(coords[0], coords[1], coords[2]);
 
            // Load coordinates
            std::string s_FieldStr;
            for (int i = 0; i < 3; i++)
            {
                s_FieldStr = fieldNames[i];
                if (f->m_session->DefinesFunction(funcName, s_FieldStr))
                {
                    LibUtilities::EquationSharedPtr ffunc =
                        f->m_session->GetFunction(funcName, s_FieldStr);
                    ffunc->Evaluate(coords[0], coords[1], coords[2], time,
                                    coords_new[i]);
                }
                else
                {
                    // This coordinate is not defined, so use (x^i)' = x^i
                    Vmath::Vcopy(npoints, coords[i], 1, coords_new[i], 1);
                }
            }
            // Load velocities
            if (f->m_session->DefinesFunction(velFuncName))
            {
                for (int i = 0; i < 3; i++)
                {
                    s_FieldStr = velFieldNames[i];
                    if (f->m_session->DefinesFunction(velFuncName, s_FieldStr))
                    {
                        LibUtilities::EquationSharedPtr ffunc =
                            f->m_session->GetFunction(velFuncName, s_FieldStr);
                        ffunc->Evaluate(coords[0], coords[1], coords[2], time,
                                        coords_vel[i]);
                    }
                }
            }
 
            // Update mapping with coordinates
            mapping->SetFromFunction(false);
            mapping->UpdateMapping(time, coords_new, coords_vel);
        }
        else if (f->m_fieldMetaDataMap["MappingType"] == "File")
        {
            ASSERTL0(f->m_fieldMetaDataMap.count("FileName"),
                     "FileName parameter for Mapping missing in field file.");
            string fileName = f->m_fieldMetaDataMap["FileName"];
            std::vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef;
            std::vector<std::vector<NekDouble>> FieldData;
 
            f->FieldIOForFile(fileName)->Import(fileName, FieldDef, FieldData);
 
            for (int j = 0; j < spacedim; ++j)
            {
                int ncoeffs = f->m_exp[0]->GetNcoeffs();
                Array<OneD, NekDouble> fieldcoeffs(ncoeffs, 0.0);
                for (int i = 0; i < FieldData.size(); ++i)
                {
                    f->m_exp[j]->ExtractDataToCoeffs(
                        FieldDef[i], FieldData[i], fieldNames[j], fieldcoeffs);
                }
                bool wavespace = f->m_exp[0]->GetWaveSpace();
                f->m_exp[0]->SetWaveSpace(false);
 
                f->m_exp[0]->BwdTrans(fieldcoeffs, coords_new[j]);
 
                // Load coordinate velocity
                if (std::find(FieldDef[0]->m_fields.begin(),
                              FieldDef[0]->m_fields.end(),
                              velFieldNames[j]) != FieldDef[0]->m_fields.end())
                {
                    for (int i = 0; i < FieldData.size(); ++i)
                    {
                        f->m_exp[j]->ExtractDataToCoeffs(
                            FieldDef[i], FieldData[i], velFieldNames[j],
                            fieldcoeffs);
                    }
                    f->m_exp[0]->BwdTrans(fieldcoeffs, coords_vel[j]);
                }
                f->m_exp[0]->SetWaveSpace(wavespace);
            }
            // Update mapping with coordinates
            mapping->SetFromFunction(false);
            mapping->UpdateMapping(time, coords_new, coords_vel);
        }
    }
    else
    {
        // Use trivial mapping
        Array<OneD, Array<OneD, NekDouble>> coords(3);
        Array<OneD, Array<OneD, NekDouble>> coords_vel(3);
        for (int i = 0; i < 3; i++)
        {
            coords[i]     = Array<OneD, NekDouble>(npoints);
            coords_vel[i] = Array<OneD, NekDouble>(npoints, 0.0);
        }
        f->m_exp[0]->GetCoords(coords[0], coords[1], coords[2]);
        mapping->SetFromFunction(false);
        mapping->UpdateMapping(time, coords, coords_vel);
    }
 
    return mapping;
}

References ASSERTL0, Nektar::StdRegions::find(), Nektar::GlobalMapping::Mapping::Load(), Nektar::GlobalMapping::MappingSharedPtr, and Vmath::Vcopy().

Referenced by Nektar::FieldUtils::ProcessBodyFittedVelocity::GetVelAndConvertToCartSys(), Nektar::FieldUtils::ProcessGrad::ProcessMappingFld(), v_Process(), Nektar::FieldUtils::ProcessVelocityDivergence::v_Process(), and Nektar::FieldUtils::ProcessVorticity::v_Process().

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 72 of file ProcessMapping.h.

    {
        return "Applying mapping to field";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 67 of file ProcessMapping.h.

    {
        return "ProcessMapping";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessMapping::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 77 of file ProcessMapping.h.

    {
        return eModifyExp;
    }

References Nektar::FieldUtils::eModifyExp.

v_Process()

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

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 58 of file ProcessMapping.cpp.

{
    m_f->SetUpExp(vm);
 
    // Determine dimensions of mesh, solution, etc...
    int npoints  = m_f->m_exp[0]->GetNpoints();
    int expdim   = m_f->m_graph->GetMeshDimension();
    int spacedim = expdim;
    if ((m_f->m_numHomogeneousDir) == 1 || (m_f->m_numHomogeneousDir) == 2)
    {
        spacedim = 3;
    }
    int nfields   = m_f->m_variables.size();
    int addfields = expdim;
 
    string fieldNames[3] = {"xCoord", "yCoord", "zCoord"};
    for (int i = 0; i < addfields; ++i)
    {
        m_f->m_variables.push_back(fieldNames[i]);
    }
 
    // Skip in case of empty partition
    if (m_f->m_exp[0]->GetNumElmts() == 0)
    {
        return;
    }
 
    m_f->m_exp.resize(nfields + addfields);
 
    // Load mapping
    GlobalMapping::MappingSharedPtr mapping = GetMapping(m_f);
 
    // Convert velocity to Cartesian system
    if (m_f->m_fieldMetaDataMap.count("MappingCartesianVel"))
    {
        if (m_f->m_fieldMetaDataMap["MappingCartesianVel"] == "False")
        {
            m_f->m_fieldMetaDataMap["MappingCartesianVel"] = "True";
 
            Array<OneD, Array<OneD, NekDouble>> vel(spacedim);
            // 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);
            // Copy result back
            for (int i = 0; i < spacedim; ++i)
            {
                if (m_f->m_exp[0]->GetWaveSpace())
                {
                    m_f->m_exp[0]->HomogeneousFwdTrans(
                        npoints, vel[i], m_f->m_exp[i]->UpdatePhys());
                }
                else
                {
                    Vmath::Vcopy(npoints, vel[i], 1,
                                 m_f->m_exp[i]->UpdatePhys(), 1);
                }
                m_f->m_exp[i]->FwdTransLocalElmt(m_f->m_exp[i]->GetPhys(),
                                                 m_f->m_exp[i]->UpdateCoeffs());
            }
        }
    }
 
    // Get coordinates from mapping
    Array<OneD, Array<OneD, NekDouble>> coords(3);
    mapping->GetCartesianCoordinates(coords[0], coords[1], coords[2]);
 
    // Add new information to m_f
    for (int i = 0; i < addfields; ++i)
    {
        m_f->m_exp[nfields + i] = m_f->AppendExpList(m_f->m_numHomogeneousDir);
        Vmath::Vcopy(npoints, coords[i], 1,
                     m_f->m_exp[nfields + i]->UpdatePhys(), 1);
        m_f->m_exp[nfields + i]->FwdTransLocalElmt(
            coords[i], m_f->m_exp[nfields + i]->UpdateCoeffs());
    }
}

References GetMapping(), Nektar::FieldUtils::Module::m_f, Nektar::GlobalMapping::MappingSharedPtr, and Vmath::Vcopy().

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessMapping::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "mapping"), ProcessMapping::create,
        "Add mapping coordinates to output file.")

Definition at line 56 of file ProcessMapping.h.