Nektar::SolverUtils::CouplingFile Class Reference

#include <CouplingFile.h>

Inheritance diagram for Nektar::SolverUtils::CouplingFile:

Public Member Functions
SOLVER_UTILS_EXPORT	CouplingFile (MultiRegions::ExpListSharedPtr field)
SOLVER_UTILS_EXPORT	~CouplingFile () override
Public Member Functions inherited from Nektar::SolverUtils::Coupling
virtual SOLVER_UTILS_EXPORT	~Coupling ()
SOLVER_UTILS_EXPORT void	Init ()
SOLVER_UTILS_EXPORT const std::map< std::string, std::string >	GetConfig ()
SOLVER_UTILS_EXPORT std::vector< std::string >	GetSendFieldNames ()
SOLVER_UTILS_EXPORT std::vector< std::string >	GetRecvFieldNames ()
SOLVER_UTILS_EXPORT void	Finalize ()
SOLVER_UTILS_EXPORT void	Send (const int step, const NekDouble time, const Array< OneD, const Array< OneD, NekDouble > > &field, std::vector< std::string > &varNames)
SOLVER_UTILS_EXPORT void	Receive (const int step, const NekDouble time, Array< OneD, Array< OneD, NekDouble > > &field, std::vector< std::string > &varNames)

Static Public Member Functions
static SOLVER_UTILS_EXPORT CouplingSharedPtr	create (MultiRegions::ExpListSharedPtr field)
	Creates an instance of this class. More...

Static Public Attributes
static std::string	className

Protected Member Functions
SOLVER_UTILS_EXPORT void	v_Init () override
SOLVER_UTILS_EXPORT void	v_Send (const int step, const NekDouble time, const Array< OneD, const Array< OneD, NekDouble > > &field, std::vector< std::string > &varNames) override
SOLVER_UTILS_EXPORT void	v_Receive (const int step, const NekDouble time, Array< OneD, Array< OneD, NekDouble > > &field, std::vector< std::string > &varNames) override
Protected Member Functions inherited from Nektar::SolverUtils::Coupling
SOLVER_UTILS_EXPORT	Coupling (MultiRegions::ExpListSharedPtr field)
virtual SOLVER_UTILS_EXPORT void	v_Init ()
virtual SOLVER_UTILS_EXPORT void	v_Send (const int step, const NekDouble time, const Array< OneD, const Array< OneD, NekDouble > > &field, std::vector< std::string > &varNames)=0
virtual SOLVER_UTILS_EXPORT void	v_Receive (const int step, const NekDouble time, Array< OneD, Array< OneD, NekDouble > > &field, std::vector< std::string > &varNames)=0
virtual SOLVER_UTILS_EXPORT void	v_Finalize ()
SOLVER_UTILS_EXPORT std::vector< int >	GenerateVariableMapping (std::vector< std::string > &vars, std::vector< std::string > &transVars)

Private Attributes
int	m_lastSend
int	m_lastReceive
SessionFunctionSharedPtr	m_inputFunction

Additional Inherited Members
Public Types inherited from Nektar::SolverUtils::Coupling
typedef std::map< std::string, std::string >	CouplingConfigMap
Protected Attributes inherited from Nektar::SolverUtils::Coupling
std::string	m_couplingName
CouplingConfigMap	m_config
MultiRegions::ExpListSharedPtr	m_evalField
int	m_nSendVars
std::vector< std::string >	m_sendFieldNames
int	m_sendSteps
int	m_nRecvVars
std::vector< std::string >	m_recvFieldNames
int	m_recvSteps

Detailed Description

Definition at line 45 of file CouplingFile.h.

Constructor & Destructor Documentation

CouplingFile()

Nektar::SolverUtils::CouplingFile::CouplingFile

(

MultiRegions::ExpListSharedPtr

field

)

Definition at line 51 of file CouplingFile.cpp.

    : Coupling(field), m_lastSend(-1E6), m_lastReceive(-1E6)
{
    m_config["RECEIVEFUNCTION"] = "CouplingIn";
    m_config["SENDFILENAME"]    = "CouplingOut_%14.8E.pts";
}

References Nektar::SolverUtils::Coupling::m_config.

~CouplingFile()

Nektar::SolverUtils::CouplingFile::~CouplingFile ( )

override

Definition at line 58 of file CouplingFile.cpp.

{
}

Member Function Documentation

create()

static SOLVER_UTILS_EXPORT CouplingSharedPtr Nektar::SolverUtils::CouplingFile::create ( MultiRegions::ExpListSharedPtr  field )

inlinestatic

Creates an instance of this class.

Definition at line 52 of file CouplingFile.h.

    {
        CouplingSharedPtr p =
            MemoryManager<CouplingFile>::AllocateSharedPtr(field);
        p->Init();
        return p;
    }

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), Nektar::SolverUtils::CouplingSharedPtr, FilterPython_Function::field, and CellMLToNektar.cellml_metadata::p.

v_Init()

void Nektar::SolverUtils::CouplingFile::v_Init ( )

overrideprotectedvirtual

Reimplemented from Nektar::SolverUtils::Coupling.

Definition at line 62 of file CouplingFile.cpp.

{
    Coupling::v_Init();
 
    if (m_nRecvVars > 0 && m_recvSteps > 0)
    {
        m_inputFunction = MemoryManager<SessionFunction>::AllocateSharedPtr(
            m_evalField->GetSession(), m_evalField, m_config["RECEIVEFUNCTION"],
            true);
    }
}

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), Nektar::SolverUtils::Coupling::m_config, Nektar::SolverUtils::Coupling::m_evalField, m_inputFunction, Nektar::SolverUtils::Coupling::m_nRecvVars, Nektar::SolverUtils::Coupling::m_recvSteps, and Nektar::SolverUtils::Coupling::v_Init().

v_Receive()

void Nektar::SolverUtils::CouplingFile::v_Receive ( const int  step, const NekDouble  time, Array< OneD, Array< OneD, NekDouble > > &  field, std::vector< std::string > &  varNames  )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Coupling.

Definition at line 135 of file CouplingFile.cpp.

{
    if (m_nRecvVars < 1 || m_recvSteps < 1)
    {
        return;
    }
 
    if (step < m_lastReceive + m_recvSteps)
    {
        return;
    }
    m_lastReceive = step;
 
    if (m_evalField->GetComm()->GetRank() == 0 &&
        m_evalField->GetSession()->DefinesCmdLineArgument("verbose"))
    {
        cout << "receiving fields at i = " << step << ", t = " << time << endl;
    }
 
    string filename = m_evalField->GetSession()->GetFunctionFilename(
        m_config["RECEIVEFUNCTION"], m_recvFieldNames[0]);
 
#if (defined _WIN32 && _MSC_VER < 1900)
    // We need this to make sure boost::format has always
    // two digits in the exponents of Scientific notation.
    unsigned int old_exponent_format;
    old_exponent_format = _set_output_format(_TWO_DIGIT_EXPONENT);
    filename            = boost::str(boost::format(filename) % time);
    _set_output_format(old_exponent_format);
#else
    filename = boost::str(boost::format(filename) % time);
#endif
 
    int exists = 0;
    while (!exists)
    {
        exists = fs::exists(filename);
        m_evalField->GetComm()->AllReduce(exists, LibUtilities::ReduceMin);
    }
 
    Array<OneD, Array<OneD, NekDouble>> recvFields(m_nRecvVars);
    m_inputFunction->Evaluate(m_recvFieldNames, recvFields, time);
 
    vector<int> recvVarsToVars =
        GenerateVariableMapping(varNames, m_recvFieldNames);
    ASSERTL1(m_nRecvVars == recvVarsToVars.size(), "field size mismatch");
    for (int i = 0; i < recvVarsToVars.size(); ++i)
    {
        Vmath::Vcopy(recvFields[i].size(), recvFields[i], 1,
                     field[recvVarsToVars[i]], 1);
    }
}

References ASSERTL1, FilterPython_Function::field, CellMLToNektar.pycml::format, Nektar::SolverUtils::Coupling::GenerateVariableMapping(), Nektar::SolverUtils::Coupling::m_config, Nektar::SolverUtils::Coupling::m_evalField, m_inputFunction, m_lastReceive, Nektar::SolverUtils::Coupling::m_nRecvVars, Nektar::SolverUtils::Coupling::m_recvFieldNames, Nektar::SolverUtils::Coupling::m_recvSteps, Nektar::LibUtilities::ReduceMin, and Vmath::Vcopy().

v_Send()

void Nektar::SolverUtils::CouplingFile::v_Send ( const int  step, const NekDouble  time, const Array< OneD, const Array< OneD, NekDouble > > &  field, std::vector< std::string > &  varNames  )

overrideprotectedvirtual

Implements Nektar::SolverUtils::Coupling.

Definition at line 74 of file CouplingFile.cpp.

{
    if (m_nSendVars < 1 || m_sendSteps < 1)
    {
        return;
    }
 
    if (step < m_lastSend + m_sendSteps)
    {
        return;
    }
    m_lastSend = step;
 
    if (m_evalField->GetComm()->GetRank() == 0 &&
        m_evalField->GetSession()->DefinesCmdLineArgument("verbose"))
    {
        cout << "sending fields at i = " << step << ", t = " << time << endl;
    }
 
    vector<int> sendVarsToVars =
        GenerateVariableMapping(varNames, m_sendFieldNames);
 
#if (defined _WIN32 && _MSC_VER < 1900)
    // We need this to make sure boost::format has always
    // two digits in the exponents of Scientific notation.
    unsigned int old_exponent_format;
    old_exponent_format = _set_output_format(_TWO_DIGIT_EXPONENT);
    std::string filename =
        boost::str(boost::format(m_config["SENDFILENAME"]) % time);
    _set_output_format(old_exponent_format);
#else
    std::string filename =
        boost::str(boost::format(m_config["SENDFILENAME"]) % time);
#endif
 
    Array<OneD, Array<OneD, NekDouble>> pts(m_nSendVars + 3);
    for (int i = 0; i < 3; ++i)
    {
        pts[i] = Array<OneD, NekDouble>(m_evalField->GetTotPoints(), 0.0);
    }
    m_evalField->GetCoords(pts[0], pts[1], pts[2]);
 
    for (int i = 0; i < m_nSendVars; ++i)
    {
        pts[3 + i] = field[sendVarsToVars[i]];
    }
 
    LibUtilities::PtsIO ptsIO(m_evalField->GetSession()->GetComm());
    LibUtilities::PtsFieldSharedPtr sPts =
        MemoryManager<LibUtilities::PtsField>::AllocateSharedPtr(
            3, m_sendFieldNames, pts);
    // we first write to a temp file and rename this to make sure the
    // receiver doesnt try to read it before we finished writing
    string tmpFn = filename + ".tmp";
    ptsIO.Write(tmpFn, sPts);
    fs::rename(tmpFn, filename);
}

References Nektar::MemoryManager< DataType >::AllocateSharedPtr(), FilterPython_Function::field, CellMLToNektar.pycml::format, Nektar::SolverUtils::Coupling::GenerateVariableMapping(), Nektar::SolverUtils::Coupling::m_config, Nektar::SolverUtils::Coupling::m_evalField, m_lastSend, Nektar::SolverUtils::Coupling::m_nSendVars, Nektar::SolverUtils::Coupling::m_sendFieldNames, Nektar::SolverUtils::Coupling::m_sendSteps, and Nektar::LibUtilities::PtsIO::Write().

Member Data Documentation

className

std::string Nektar::SolverUtils::CouplingFile::className

static

Initial value:

=
    GetCouplingFactory().RegisterCreatorFunction("File", CouplingFile::create,
                                                 "File Coupling")

Definition at line 49 of file CouplingFile.h.

m_inputFunction

SessionFunctionSharedPtr Nektar::SolverUtils::CouplingFile::m_inputFunction

private

Definition at line 82 of file CouplingFile.h.

Referenced by v_Init(), and v_Receive().

m_lastReceive

int Nektar::SolverUtils::CouplingFile::m_lastReceive

private

Definition at line 80 of file CouplingFile.h.

Referenced by v_Receive().

m_lastSend

int Nektar::SolverUtils::CouplingFile::m_lastSend

private

Definition at line 79 of file CouplingFile.h.

Referenced by v_Send().