Nektar::Utilities::ProcessInterpField Class Reference

This processing module interpolates one field to another. More...

#include <ProcessInterpField.h>

Inheritance diagram for Nektar::Utilities::ProcessInterpField:

Collaboration diagram for Nektar::Utilities::ProcessInterpField:

Public Member Functions
	ProcessInterpField (FieldSharedPtr f)
virtual	~ProcessInterpField ()
virtual void	Process (po::variables_map &vm)
	Write mesh to output file. More...
virtual std::string	GetModuleName ()
Public Member Functions inherited from Nektar::Utilities::ProcessModule
	ProcessModule ()
	ProcessModule (FieldSharedPtr p_f)
	ProcessModule (MeshSharedPtr p_m)
Public Member Functions inherited from Nektar::Utilities::Module
	Module (FieldSharedPtr p_f)
void	RegisterConfig (string key, string value)
	Register a configuration option with a module. More...
void	PrintConfig ()
	Print out all configuration options for a module. More...
void	SetDefaults ()
	Sets default configuration options for those which have not been set. More...
bool	GetRequireEquiSpaced (void)
void	SetRequireEquiSpaced (bool pVal)
void	EvaluateTriFieldAtEquiSpacedPts (LocalRegions::ExpansionSharedPtr &exp, const Array< OneD, const NekDouble > &infield, Array< OneD, NekDouble > &outfield)
	Module (MeshSharedPtr p_m)
virtual void	Process ()=0
void	RegisterConfig (std::string key, std::string value)
void	PrintConfig ()
void	SetDefaults ()
MeshSharedPtr	GetMesh ()
virtual void	ProcessVertices ()
	Extract element vertices. More...
virtual void	ProcessEdges (bool ReprocessEdges=true)
	Extract element edges. More...
virtual void	ProcessFaces (bool ReprocessFaces=true)
	Extract element faces. More...
virtual void	ProcessElements ()
	Generate element IDs. More...
virtual void	ProcessComposites ()
	Generate composites. More...
virtual void	ClearElementLinks ()

Static Public Member Functions
static boost::shared_ptr< Module >	create (FieldSharedPtr f)
	Creates an instance of this class. More...

Static Public Attributes
static ModuleKey	className

Private Member Functions
void	InterpolateField (vector< MultiRegions::ExpListSharedPtr > &field0, vector< MultiRegions::ExpListSharedPtr > &field1, Array< OneD, NekDouble > x, Array< OneD, NekDouble > y, Array< OneD, NekDouble > z, NekDouble clamp_low, NekDouble clamp_up, NekDouble def_value)

Private Attributes
FieldSharedPtr	m_fromField

Additional Inherited Members
Protected Member Functions inherited from Nektar::Utilities::Module
	Module ()
void	ReorderPrisms (PerMap &perFaces)
	Reorder node IDs so that prisms and tetrahedra are aligned correctly. More...
void	PrismLines (int prism, PerMap &perFaces, std::set< int > &prismsDone, std::vector< ElementSharedPtr > &line)
Protected Attributes inherited from Nektar::Utilities::Module
FieldSharedPtr	m_f
	Field object. More...
map< string, ConfigOption >	m_config
	List of configuration values. More...
bool	m_requireEquiSpaced
MeshSharedPtr	m_mesh
	Mesh object. More...
std::map< std::string, ConfigOption >	m_config
	List of configuration values. More...

Detailed Description

This processing module interpolates one field to another.

Definition at line 49 of file ProcessInterpField.h.

Constructor & Destructor Documentation

Nektar::Utilities::ProcessInterpField::ProcessInterpField

(

FieldSharedPtr

f

)

Definition at line 57 of file ProcessInterpField.cpp.

References Nektar::Utilities::Module::m_config.

                                                       : ProcessModule(f)
{

    m_config["fromxml"]            = ConfigOption(false, "NotSet",
                                    "Xml file form which to interpolate field");
    m_config["fromfld"]            = ConfigOption(false, "NotSet",
                                    "Fld file form which to interpolate field");

    m_config["clamptolowervalue"] = ConfigOption(false,"-10000000",
                                    "Lower bound for interpolation value");
    m_config["clamptouppervalue"] = ConfigOption(false,"10000000",
                                    "Upper bound for interpolation value");
    m_config["defaultvalue"]      = ConfigOption(false,"0",
                                    "Default value if point is outside domain");
}

Nektar::Utilities::ProcessInterpField::~ProcessInterpField ( )

virtual

Definition at line 73 of file ProcessInterpField.cpp.

{
}

Member Function Documentation

static boost::shared_ptr<Module> Nektar::Utilities::ProcessInterpField::create ( FieldSharedPtr  f )

inlinestatic

Creates an instance of this class.

Definition at line 53 of file ProcessInterpField.h.

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

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

virtual std::string Nektar::Utilities::ProcessInterpField::GetModuleName ( )

inlinevirtual

Implements Nektar::Utilities::Module.

Definition at line 64 of file ProcessInterpField.h.

        {
            return "ProcessInterpField";
        }

void Nektar::Utilities::ProcessInterpField::InterpolateField ( vector< MultiRegions::ExpListSharedPtr > &  field0, vector< MultiRegions::ExpListSharedPtr > &  field1, Array< OneD, NekDouble >  x, Array< OneD, NekDouble >  y, Array< OneD, NekDouble >  z, NekDouble  clamp_low, NekDouble  clamp_up, NekDouble  def_value  )

private

Definition at line 258 of file ProcessInterpField.cpp.

References ASSERTL0.

Referenced by Process().

{
    int expdim = field0[0]->GetCoordim(0);

    Array<OneD, NekDouble> coords(expdim), Lcoords(expdim);
    int nq1 = field1[0]->GetTotPoints();
    int elmtid, offset;
    int r, f;
    static int intpts = 0;

    ASSERTL0(field0.size() == field1.size(),
             "Input field dimension must be same as output dimension");

    for (r = 0; r < nq1; r++)
    {
        coords[0] = x[r];
        coords[1] = y[r];
        if (expdim == 3)
        {
            coords[2] = z[r];
        }

        // Obtain nearest Element and LocalCoordinate to interpolate
        elmtid = field0[0]->GetExpIndex(coords, Lcoords, 1e-3,true);

        if(elmtid >= 0)
        {
            offset = field0[0]->GetPhys_Offset(field0[0]->
                                               GetOffset_Elmt_Id(elmtid));

            for (f = 0; f < field1.size(); ++f)
            {
                NekDouble value;
                value = field0[f]->GetExp(elmtid)->
                    StdPhysEvaluate(Lcoords, field0[f]->GetPhys() +offset);

                if ((boost::math::isnan)(value))
                {
                    ASSERTL0(false, "new value is not a number");
                }
                else
                {
                    if(value > clamp_up)
                    {
                        value = clamp_up;
                    }
                    else if( value < clamp_low)
                    {
                        value = clamp_low;
                    }

                    field1[f]->UpdatePhys()[r] = value;
                }
            }
        }
        else
        {
            for (f = 0; f < field1.size(); ++f)
            {
                field1[f]->UpdatePhys()[r] = def_value;
            }
        }

        if (intpts%1000 == 0)
        {
            cout <<"." << flush;
        }
        intpts ++;
    }
}

void Nektar::Utilities::ProcessInterpField::Process ( po::variables_map &  vm )

virtual

Write mesh to output file.

Implements Nektar::Utilities::Module.

Definition at line 77 of file ProcessInterpField.cpp.

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), ASSERTL0, Nektar::LibUtilities::SessionReader::CreateInstance(), InterpolateField(), Nektar::Utilities::Module::m_config, Nektar::Utilities::Module::m_f, m_fromField, npts, Nektar::LibUtilities::NullFieldMetaDataMap, Nektar::NullNekDouble1DArray, Nektar::SpatialDomains::MeshGraph::Read(), Vmath::Vmax(), and Vmath::Vmin().

{
    if(m_f->m_verbose)
    {
        if(m_f->m_comm->TreatAsRankZero())
        {
            cout << "ProcessInterpField: Interpolating field..." << endl;
        }
    }

    m_fromField =  boost::shared_ptr<Field>(new Field());

    std::vector<std::string> files;

    // set up session file for from field
    files.push_back(m_config["fromxml"].as<string>());
    m_fromField->m_session = LibUtilities::SessionReader::
        CreateInstance(0, 0, files);

    // Set up range based on min and max of local parallel partition
    SpatialDomains::DomainRangeShPtr rng =
            MemoryManager<SpatialDomains::DomainRange>::AllocateSharedPtr();

    int coordim = m_f->m_exp[0]->GetCoordim(0);
    int npts = m_f->m_exp[0]->GetTotPoints();
    Array<OneD, Array<OneD, NekDouble> > coords(3);


    for(int i = 0; i < coordim; ++i)
    {
        coords[i] = Array<OneD, NekDouble>(npts);
    }

    for(int i = coordim; i < 3; ++i)
    {
        coords[i] = NullNekDouble1DArray;
    }

    m_f->m_exp[0]->GetCoords(coords[0],coords[1],coords[2]);

    rng->m_checkShape   = false;
    switch(coordim)
    {
    case 3:
        rng->m_doZrange = true;
        rng->m_zmin     = Vmath::Vmin(npts,coords[2],1);
        rng->m_zmax     = Vmath::Vmax(npts,coords[2],1);
    case 2:
        rng->m_doYrange = true;
        rng->m_ymin     = Vmath::Vmin(npts,coords[1],1);
        rng->m_ymax     = Vmath::Vmax(npts,coords[1],1);
    case 1:
        rng->m_doXrange = true;
        rng->m_xmin     = Vmath::Vmin(npts,coords[0],1);
        rng->m_xmax     = Vmath::Vmax(npts,coords[0],1);
        break;
    default:
        ASSERTL0(false,"too many values specfied in range");
    }

    // setup rng parameters.
    m_fromField->m_graph =
            SpatialDomains::MeshGraph::Read(m_fromField->m_session,rng);

    // Read in local from field partitions
    const SpatialDomains::ExpansionMap &expansions =
            m_fromField->m_graph->GetExpansions();

    // check for case where no elements are specified on this
    // parallel partition
    if(!expansions.size())
    {
        return;
    }

    Array<OneD,int> ElementGIDs(expansions.size());
    SpatialDomains::ExpansionMap::const_iterator expIt;

    int i = 0;
    for (expIt = expansions.begin(); expIt != expansions.end();
         ++expIt)
    {
        ElementGIDs[i++] = expIt->second->m_geomShPtr->GetGlobalID();
    }

    string fromfld = m_config["fromfld"].as<string>();
    m_f->m_fld->Import(fromfld,m_fromField->m_fielddef,
                       m_fromField->m_data,
                       LibUtilities::NullFieldMetaDataMap,
                       ElementGIDs);

    int NumHomogeneousDir = m_fromField->m_fielddef[0]->m_numHomogeneousDir;

    //----------------------------------------------
    // Set up Expansion information to use mode order from field
    m_fromField->m_graph->SetExpansions(m_fromField->m_fielddef);

    int nfields = m_fromField->m_fielddef[0]->m_fields.size();

    m_fromField->m_exp.resize(nfields);
    m_fromField->m_exp[0] = m_fromField->SetUpFirstExpList(NumHomogeneousDir,true);

    m_f->m_exp.resize(nfields);

    // declare auxiliary fields.
    for(i = 1; i < nfields; ++i)
    {
        m_f->m_exp[i]         = m_f->AppendExpList(NumHomogeneousDir);
        m_fromField->m_exp[i] = m_fromField->AppendExpList(NumHomogeneousDir);
    }


    // load field into expansion in fromfield.
    for(int j = 0; j < nfields; ++j)
    {
        for (i = 0; i < m_fromField->m_fielddef.size(); i++)
        {
            m_fromField->m_exp[j]->ExtractDataToCoeffs(
                                        m_fromField->m_fielddef[i],
                                        m_fromField->m_data[i],
                                        m_fromField->m_fielddef[0]->m_fields[j],
                                        m_fromField->m_exp[j]->UpdateCoeffs());
        }
        m_fromField->m_exp[j]->BwdTrans(m_fromField->m_exp[j]->GetCoeffs(),
                                        m_fromField->m_exp[j]->UpdatePhys());

    }

    int nq1 = m_f->m_exp[0]->GetTotPoints();

    Array<OneD, NekDouble> x1(nq1);
    Array<OneD, NekDouble> y1(nq1);
    Array<OneD, NekDouble> z1(nq1);

    if (coordim == 2)
    {
        m_f->m_exp[0]->GetCoords(x1, y1);
    }
    else if (coordim == 3)
    {
        m_f->m_exp[0]->GetCoords(x1, y1, z1);
    }

    if(m_f->m_session->GetComm()->TreatAsRankZero())
    {
        cout << "Interpolating [" << flush;
    }

    NekDouble clamp_low = m_config["clamptolowervalue"].as<NekDouble>();
    NekDouble clamp_up  = m_config["clamptouppervalue"].as<NekDouble>();
    NekDouble def_value = m_config["defaultvalue"].as<NekDouble>();

    InterpolateField(m_fromField->m_exp, m_f->m_exp,
                     x1, y1, z1, clamp_low, clamp_up,def_value);

    if(m_f->m_session->GetComm()->TreatAsRankZero())
    {
        cout << "]" << endl;
    }


    // put field into field data for output
    std::vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef
        = m_f->m_exp[0]->GetFieldDefinitions();
    std::vector<std::vector<NekDouble> > FieldData(FieldDef.size());

    for (int j = 0; j < nfields; ++j)
    {
        m_f->m_exp[j]->FwdTrans(m_f->m_exp[j]->GetPhys(),
                                m_f->m_exp[j]->UpdateCoeffs());
        for (i = 0; i < FieldDef.size(); ++i)
        {
            FieldDef[i]->m_fields.push_back(m_fromField->m_fielddef[0]->m_fields[j]);
            m_f->m_exp[j]->AppendFieldData(FieldDef[i], FieldData[i]);
        }
    }

    m_f->m_fielddef = FieldDef;
    m_f->m_data     = FieldData;
}

Member Data Documentation

ModuleKey Nektar::Utilities::ProcessInterpField::className

static

Initial value:

=
    GetModuleFactory().RegisterCreatorFunction(
       ModuleKey(eProcessModule, "interpfield"),
       ProcessInterpField::create,
       "Interpolates one field to another, requires fromxml, "
       "fromfld to be defined")

Definition at line 56 of file ProcessInterpField.h.

FieldSharedPtr Nektar::Utilities::ProcessInterpField::m_fromField

private

Definition at line 70 of file ProcessInterpField.h.

Referenced by Process().