Nektar::FieldUtils::ProcessCreateExp Class Reference

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

#include <ProcessCreateExp.h>

Inheritance diagram for Nektar::FieldUtils::ProcessCreateExp:

Public Member Functions
	ProcessCreateExp (FieldSharedPtr f)
	~ProcessCreateExp () 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...
void	LoadFieldData (bool useSessionVariables=false)
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 47 of file ProcessCreateExp.h.

Constructor & Destructor Documentation

ProcessCreateExp()

Nektar::FieldUtils::ProcessCreateExp::ProcessCreateExp

(

FieldSharedPtr

f

)

Definition at line 52 of file ProcessCreateExp.cpp.

                                                   : ProcessModule(f)
{
}

~ProcessCreateExp()

Nektar::FieldUtils::ProcessCreateExp::~ProcessCreateExp ( )

override

Definition at line 56 of file ProcessCreateExp.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 51 of file ProcessCreateExp.h.

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

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

LoadFieldData()

void Nektar::FieldUtils::ProcessCreateExp::LoadFieldData ( bool  useSessionVariables = false )

protected

Definition at line 185 of file ProcessCreateExp.cpp.

{
    int i, j;
    int nfields, nstrips;
    m_f->m_session->LoadParameter("Strip_Z", nstrips, 1);
    vector<string> vars = m_f->m_session->GetVariables();
 
    if (useSessionVariables)
    {
        m_f->m_variables = vars;
    }
    nfields = m_f->m_variables.size();
 
    m_f->m_exp.resize(nfields * nstrips);
    // declare other fields;
    for (int s = 0; s < nstrips; ++s) // homogeneous strip varient
    {
        for (i = 0; i < nfields; ++i)
        {
            if (i < vars.size())
            {
                // check to see if field already defined
                if (!m_f->m_exp[s * nfields + i])
                {
                    m_f->m_exp[s * nfields + i] =
                        m_f->AppendExpList(m_f->m_numHomogeneousDir, vars[i]);
                }
            }
            else
            {
                if (vars.size())
                {
                    m_f->m_exp[s * nfields + i] =
                        m_f->AppendExpList(m_f->m_numHomogeneousDir, vars[0]);
                }
                else
                {
                    m_f->m_exp[s * nfields + i] =
                        m_f->AppendExpList(m_f->m_numHomogeneousDir);
                }
            }
        }
    }
 
    // Extract data to coeffs and bwd transform
    for (int s = 0; s < nstrips; ++s) // homogeneous strip varient
    {
        for (j = 0; j < nfields; ++j)
        {
            for (i = 0; i < m_f->m_data.size() / nstrips; ++i)
            {
                int n = i * nstrips + s;
                // In case of multiple flds, we might not have a
                //   variable in this m_data[n] -> skip in this case
                auto it = find(m_f->m_fielddef[n]->m_fields.begin(),
                               m_f->m_fielddef[n]->m_fields.end(),
                               m_f->m_variables[j]);
                if (it != m_f->m_fielddef[n]->m_fields.end())
                {
                    m_f->m_exp[s * nfields + j]->ExtractDataToCoeffs(
                        m_f->m_fielddef[n], m_f->m_data[n], m_f->m_variables[j],
                        m_f->m_exp[s * nfields + j]->UpdateCoeffs());
                }
            }
            m_f->m_exp[s * nfields + j]->BwdTrans(
                m_f->m_exp[s * nfields + j]->GetCoeffs(),
                m_f->m_exp[s * nfields + j]->UpdatePhys());
        }
    }
    // Clear fielddef and data (they should not be used after running this
    // module)
    m_f->m_fielddef = vector<LibUtilities::FieldDefinitionsSharedPtr>();
    m_f->m_data     = vector<std::vector<NekDouble>>();
}

References Nektar::StdRegions::find(), and Nektar::FieldUtils::Module::m_f.

Referenced by v_Process().

v_GetModuleDescription()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 71 of file ProcessCreateExp.h.

    {
        return "Creating m_exp if needed";
    }

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 66 of file ProcessCreateExp.h.

    {
        return "ProcessCreateExp";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::ProcessCreateExp::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 76 of file ProcessCreateExp.h.

    {
        return eCreateExp;
    }

References Nektar::FieldUtils::eCreateExp.

v_Process()

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

overrideprotectedvirtual

Write mesh to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 60 of file ProcessCreateExp.cpp.

{
    if (m_f->m_graph)
    {
        LibUtilities::Timer timerpart;
        if (m_f->m_verbose)
        {
            if (m_f->m_comm->TreatAsRankZero())
            {
                timerpart.Start();
            }
        }
        // check to see if fld file defined so can use in
        // expansion defintion if required
        bool fldfilegiven = (m_f->m_fielddef.size() != 0);
        bool expFromFld   = fldfilegiven && !vm.count("use-session-expansion");
 
        // load fielddef header if fld file is defined. This gives
        // precedence to Homogeneous definition in fld file
        m_f->m_numHomogeneousDir = 0;
        if (expFromFld)
        {
            m_f->m_numHomogeneousDir = m_f->m_fielddef[0]->m_numHomogeneousDir;
 
            // Set up Expansion information to use mode order from field
            m_f->m_graph->SetExpansionInfo(m_f->m_fielddef);
        }
        else
        {
            if (m_f->m_session->DefinesSolverInfo("HOMOGENEOUS"))
            {
                std::string HomoStr =
                    m_f->m_session->GetSolverInfo("HOMOGENEOUS");
 
                if ((HomoStr == "HOMOGENEOUS1D") ||
                    (HomoStr == "Homogeneous1D") || (HomoStr == "1D") ||
                    (HomoStr == "Homo1D"))
                {
                    m_f->m_numHomogeneousDir = 1;
                }
                if ((HomoStr == "HOMOGENEOUS2D") ||
                    (HomoStr == "Homogeneous2D") || (HomoStr == "2D") ||
                    (HomoStr == "Homo2D"))
                {
                    m_f->m_numHomogeneousDir = 2;
                }
            }
        }
 
        m_f->m_exp.resize(1);
        // Check  if there are any elements to process
        vector<int> IDs;
        auto domain = m_f->m_graph->GetDomain();
        for (int d = 0; d < domain.size(); ++d)
        {
            for (auto &compIter : domain[d])
            {
                for (auto &x : compIter.second->m_geomVec)
                {
                    IDs.push_back(x->GetGlobalID());
                }
            }
        }
        // if Range has been specified it is possible to have a
        // partition which is empty so check this and return with empty
        // expansion if no elements present.
        if (!IDs.size())
        {
            m_f->m_exp[0] =
                MemoryManager<MultiRegions::ExpList>::AllocateSharedPtr();
            return;
        }
 
        // Adjust number of quadrature points
        if (vm.count("output-points"))
        {
            int nPointsNew = vm["output-points"].as<int>();
            m_f->m_graph->SetExpansionInfoToPointOrder(nPointsNew);
        }
 
        if (m_f->m_verbose)
        {
            if (m_f->m_comm->TreatAsRankZero())
            {
                timerpart.Stop();
                NekDouble cpuTime = timerpart.TimePerTest(1);
 
                stringstream ss;
                ss << cpuTime << "s";
                cout << "\t ProcessCreateExp setexpansion CPU Time: " << setw(8)
                     << left << ss.str() << endl;
                timerpart.Start();
            }
        }
        // Override number of planes with value from cmd line
        if (m_f->m_numHomogeneousDir == 1 && vm.count("output-points-hom-z"))
        {
            int expdim = m_f->m_graph->GetMeshDimension();
            m_f->m_fielddef[0]->m_numModes[expdim] =
                vm["output-points-hom-z"].as<int>();
        }
        m_f->m_exp[0] =
            m_f->SetUpFirstExpList(m_f->m_numHomogeneousDir, expFromFld);
        if (m_f->m_verbose)
        {
            if (m_f->m_comm->TreatAsRankZero())
            {
                timerpart.Stop();
                NekDouble cpuTime = timerpart.TimePerTest(1);
 
                stringstream ss1;
 
                ss1 << cpuTime << "s";
                cout << "\t ProcessCreateExp set first exp CPU Time: "
                     << setw(8) << left << ss1.str() << endl;
            }
        }
 
        if (fldfilegiven)
        {
            LoadFieldData(vm.count("use-session-variables"));
        }
    }
}

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), Nektar::UnitTests::d(), LoadFieldData(), Nektar::FieldUtils::Module::m_f, Nektar::LibUtilities::Timer::Start(), Nektar::LibUtilities::Timer::Stop(), and Nektar::LibUtilities::Timer::TimePerTest().

Member Data Documentation

className

ModuleKey Nektar::FieldUtils::ProcessCreateExp::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
        ModuleKey(eProcessModule, "createExp"), ProcessCreateExp::create,
        "dummy module used to create m_exp.")

Definition at line 55 of file ProcessCreateExp.h.