#include <Coupling.h>

Inheritance diagram for Nektar::SolverUtils::Coupling:

Public Types
typedef std::map< std::string, std::string >	CouplingConfigMap

Public Member Functions
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)

Protected Member Functions
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)

Protected Attributes
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 57 of file Coupling.h.

Member Typedef Documentation

◆ CouplingConfigMap

typedef std::map<std::string, std::string> Nektar::SolverUtils::Coupling::CouplingConfigMap

Definition at line 61 of file Coupling.h.

Constructor & Destructor Documentation

◆ ~Coupling()

virtual SOLVER_UTILS_EXPORT Nektar::SolverUtils::Coupling::~Coupling ( )

inlinevirtual

Definition at line 63 of file Coupling.h.

64 {

65 }

◆ Coupling()

Nektar::SolverUtils::Coupling::Coupling ( MultiRegions::ExpListSharedPtr field )

protected

Definition at line 50 of file Coupling.cpp.

    : m_couplingName(""), m_evalField(field), m_nSendVars(0), m_sendSteps(0),
      m_nRecvVars(0), m_recvSteps(0)
{
    m_config["RECEIVESTEPS"]     = "0";
    m_config["RECEIVEVARIABLES"] = "";
 
    m_config["SENDSTEPS"]     = "0";
    m_config["SENDVARIABLES"] = "";
}

References m_config.

Member Function Documentation

◆ Finalize()

SOLVER_UTILS_EXPORT void Nektar::SolverUtils::Coupling::Finalize ( )

inline

Definition at line 87 of file Coupling.h.

    {
        v_Finalize();
    }

References v_Finalize().

◆ GenerateVariableMapping()

vector< int > Nektar::SolverUtils::Coupling::GenerateVariableMapping	(	std::vector< std::string > &	vars,
		std::vector< std::string > &	transVars
	)

protected

Definition at line 134 of file Coupling.cpp.

{
    vector<int> transToVars;
    Array<OneD, Array<OneD, NekDouble>> sendField(transVars.size());
    for (int i = 0; i < transVars.size(); ++i)
    {
        auto it2 = find(vars.begin(), vars.end(), transVars[i]);
        ASSERTL0(it2 != vars.end(),
                 "send variable " + transVars[i] + " not found");
        int id = distance(vars.begin(), it2);
 
        transToVars.push_back(id);
    }
 
    return transToVars;
}

References ASSERTL0, and Nektar::StdRegions::find().

Referenced by Nektar::SolverUtils::CouplingCwipi::v_Receive(), Nektar::SolverUtils::CouplingFile::v_Receive(), Nektar::SolverUtils::CouplingCwipi::v_Send(), and Nektar::SolverUtils::CouplingFile::v_Send().

◆ GetConfig()

SOLVER_UTILS_EXPORT const std::map< std::string, std::string > Nektar::SolverUtils::Coupling::GetConfig ( )

inline

Definition at line 72 of file Coupling.h.

    {
        return m_config;
    }

References m_config.

◆ GetRecvFieldNames()

SOLVER_UTILS_EXPORT std::vector< std::string > Nektar::SolverUtils::Coupling::GetRecvFieldNames ( )

inline

Definition at line 82 of file Coupling.h.

    {
        return m_recvFieldNames;
    }

References m_recvFieldNames.

◆ GetSendFieldNames()

SOLVER_UTILS_EXPORT std::vector< std::string > Nektar::SolverUtils::Coupling::GetSendFieldNames ( )

inline

Definition at line 77 of file Coupling.h.

    {
        return m_sendFieldNames;
    }

References m_sendFieldNames.

◆ Init()

SOLVER_UTILS_EXPORT void Nektar::SolverUtils::Coupling::Init ( )

inline

Definition at line 67 of file Coupling.h.

    {
        v_Init();
    }

References v_Init().

◆ Receive()

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

inline

Definition at line 100 of file Coupling.h.

    {
        v_Receive(step, time, field, varNames);
    }

References v_Receive().

◆ Send()

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

inline

Definition at line 92 of file Coupling.h.

    {
        v_Send(step, time, field, varNames);
    }

References v_Send().

◆ v_Finalize()

virtual SOLVER_UTILS_EXPORT void Nektar::SolverUtils::Coupling::v_Finalize ( void )

inlineprotectedvirtual

Reimplemented in Nektar::SolverUtils::CouplingCwipi.

Definition at line 137 of file Coupling.h.

138 {

139 }

Referenced by Finalize().

◆ v_Init()

void Nektar::SolverUtils::Coupling::v_Init ( )

protectedvirtual

Reimplemented in Nektar::SolverUtils::CouplingCwipi, and Nektar::SolverUtils::CouplingFile.

Definition at line 61 of file Coupling.cpp.

{
    LibUtilities::SessionReaderSharedPtr session = m_evalField->GetSession();
 
    TiXmlElement *vCoupling = session->GetElement("Nektar/Coupling");
    ASSERTL0(vCoupling, "Invalid Coupling config");
 
    vCoupling->QueryStringAttribute("NAME", &m_couplingName);
    ASSERTL0(m_couplingName.size(), "No Coupling NAME attribute set");
 
    TiXmlElement *element = vCoupling->FirstChildElement("I");
    while (element)
    {
        std::stringstream tagcontent;
        tagcontent << *element;
        // read the property name
        ASSERTL0(element->Attribute("PROPERTY"),
                 "Missing PROPERTY attribute in Coupling section "
                 "XML element: \n\t'" +
                     tagcontent.str() + "'");
        std::string property = element->Attribute("PROPERTY");
        ASSERTL0(!property.empty(),
                 "PROPERTY attribute must be non-empty in XML "
                 "element: \n\t'" +
                     tagcontent.str() + "'");
 
        // make sure that solver property is capitalised
        std::string propertyUpper = boost::to_upper_copy(property);
 
        CouplingConfigMap::const_iterator x = m_config.find(propertyUpper);
        ASSERTL0(x != m_config.end(),
                 "Invalid PROPERTY attribute in Coupling section "
                 "XML element: \n\t'" +
                     tagcontent.str() + "'");
 
        // read the value
        ASSERTL0(element->Attribute("VALUE"),
                 "Missing VALUE attribute in Coupling section "
                 "XML element: \n\t'" +
                     tagcontent.str() + "'");
        std::string value = element->Attribute("VALUE");
        ASSERTL0(!value.empty(), "VALUE attribute must be non-empty in XML "
                                 "element: \n\t'" +
                                     tagcontent.str() + "'");
 
        // Set Variable
        m_config[propertyUpper] = value;
 
        element = element->NextSiblingElement("I");
    }
 
    // mangle config into variables. This is ugly
    ParseUtils::GenerateVector(m_config["RECEIVEVARIABLES"], m_recvFieldNames);
    m_nRecvVars = m_recvFieldNames.size();
 
    ParseUtils::GenerateVector(m_config["SENDVARIABLES"], m_sendFieldNames);
    m_nSendVars = m_sendFieldNames.size();
 
    m_recvSteps = boost::lexical_cast<int>(m_config["RECEIVESTEPS"]);
    m_sendSteps = boost::lexical_cast<int>(m_config["SENDSTEPS"]);
 
    if (session->GetComm()->GetRank() == 0 &&
        session->DefinesCmdLineArgument("verbose") && m_config.size() > 0)
    {
        cout << "Coupling Config:" << endl;
        CouplingConfigMap::iterator x;
        for (x = m_config.begin(); x != m_config.end(); ++x)
        {
            cout << "\t" << x->first << " = '" << x->second << "'" << endl;
        }
    }
}

References ASSERTL0, Nektar::ParseUtils::GenerateVector(), m_config, m_couplingName, m_evalField, m_nRecvVars, m_nSendVars, m_recvFieldNames, m_recvSteps, m_sendFieldNames, and m_sendSteps.

Referenced by Init(), Nektar::SolverUtils::CouplingCwipi::v_Init(), and Nektar::SolverUtils::CouplingFile::v_Init().

◆ v_Receive()

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

protectedpure virtual

Implemented in Nektar::SolverUtils::CouplingCwipi, and Nektar::SolverUtils::CouplingFile.

Referenced by Receive().

◆ v_Send()

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

protectedpure virtual

Implemented in Nektar::SolverUtils::CouplingCwipi, and Nektar::SolverUtils::CouplingFile.

Referenced by Send().

Member Data Documentation

◆ m_config

CouplingConfigMap Nektar::SolverUtils::Coupling::m_config

protected

Definition at line 111 of file Coupling.h.

◆ m_couplingName

std::string Nektar::SolverUtils::Coupling::m_couplingName

protected

Definition at line 109 of file Coupling.h.

◆ m_evalField

MultiRegions::ExpListSharedPtr Nektar::SolverUtils::Coupling::m_evalField

protected

Definition at line 113 of file Coupling.h.

◆ m_nRecvVars

int Nektar::SolverUtils::Coupling::m_nRecvVars

protected

Definition at line 119 of file Coupling.h.

Referenced by Nektar::SolverUtils::CouplingCwipi::DumpRawFields(), Nektar::SolverUtils::CouplingCwipi::ExtrapolateFields(), Nektar::SolverUtils::CouplingCwipi::ReceiveCwipi(), Nektar::SolverUtils::CouplingCwipi::ReceiveStart(), Nektar::SolverUtils::CouplingCwipi::SetupReceive(), v_Init(), Nektar::SolverUtils::CouplingCwipi::v_Init(), Nektar::SolverUtils::CouplingFile::v_Init(), Nektar::SolverUtils::CouplingCwipi::v_Receive(), and Nektar::SolverUtils::CouplingFile::v_Receive().

◆ m_nSendVars

int Nektar::SolverUtils::Coupling::m_nSendVars

protected

Definition at line 115 of file Coupling.h.

Referenced by Nektar::SolverUtils::CouplingCwipi::EvaluateFields(), Nektar::SolverUtils::CouplingCwipi::SendCallback(), Nektar::SolverUtils::CouplingCwipi::SetupSend(), v_Init(), Nektar::SolverUtils::CouplingCwipi::v_Init(), Nektar::SolverUtils::CouplingCwipi::v_Send(), and Nektar::SolverUtils::CouplingFile::v_Send().

◆ m_recvFieldNames

std::vector<std::string> Nektar::SolverUtils::Coupling::m_recvFieldNames

protected

Definition at line 120 of file Coupling.h.

Referenced by Nektar::SolverUtils::CouplingCwipi::DumpRawFields(), GetRecvFieldNames(), Nektar::SolverUtils::CouplingCwipi::ReceiveCwipi(), v_Init(), Nektar::SolverUtils::CouplingCwipi::v_Receive(), and Nektar::SolverUtils::CouplingFile::v_Receive().

◆ m_recvSteps

int Nektar::SolverUtils::Coupling::m_recvSteps

protected

Definition at line 121 of file Coupling.h.

Referenced by Nektar::SolverUtils::CouplingCwipi::ReceiveCwipi(), v_Init(), Nektar::SolverUtils::CouplingCwipi::v_Init(), Nektar::SolverUtils::CouplingFile::v_Init(), Nektar::SolverUtils::CouplingCwipi::v_Receive(), and Nektar::SolverUtils::CouplingFile::v_Receive().

◆ m_sendFieldNames

std::vector<std::string> Nektar::SolverUtils::Coupling::m_sendFieldNames

protected

Definition at line 116 of file Coupling.h.

Referenced by GetSendFieldNames(), v_Init(), Nektar::SolverUtils::CouplingCwipi::v_Send(), and Nektar::SolverUtils::CouplingFile::v_Send().

◆ m_sendSteps

int Nektar::SolverUtils::Coupling::m_sendSteps

protected

Definition at line 117 of file Coupling.h.

Referenced by v_Init(), Nektar::SolverUtils::CouplingCwipi::v_Init(), Nektar::SolverUtils::CouplingCwipi::v_Send(), and Nektar::SolverUtils::CouplingFile::v_Send().

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ CouplingConfigMap

Constructor & Destructor Documentation

◆ ~Coupling()

◆ Coupling()

Member Function Documentation

◆ Finalize()

◆ GenerateVariableMapping()

◆ GetConfig()

◆ GetRecvFieldNames()

◆ GetSendFieldNames()

◆ Init()

◆ Receive()

◆ Send()

◆ v_Finalize()

◆ v_Init()

◆ v_Receive()

◆ v_Send()

Member Data Documentation

◆ m_config

◆ m_couplingName

◆ m_evalField

◆ m_nRecvVars

◆ m_nSendVars

◆ m_recvFieldNames

◆ m_recvSteps

◆ m_sendFieldNames

◆ m_sendSteps