spades::models::Phold Class Reference

PHOLD model. More...

#include <Phold.H>

Collaboration diagram for spades::models::Phold:

Classes
struct	InitEntityOp
	A struct that defines an operator for initializing entities. More...
struct	InitMessageOp
	A struct that defines an operator for initializing entities. More...
struct	ProcessOp
	A struct that defines an operator for processing messages. More...

Public Types
using	ProcessType = ProcessOp
using	InitEntityType = InitEntityOp
using	InitMessageType = InitMessageOp

Public Member Functions
	Phold ()
	Constructor.
void	read_parameters ()
	Read user parameters.
const amrex::Geometry &	geom () const
ProcessType	process_op () const
	Message processing operator.
InitEntityType	init_entity_op () const
	Initialize entity operator.
InitMessageType	init_message_op () const
	Initialize message operator.

Static Public Member Functions
static std::string	identifier ()
	Class identifier name.

Public Attributes
ProcessOp	m_process_op
InitEntityOp	m_init_entity_op
InitMessageOp	m_init_message_op

Private Attributes
amrex::Geometry	m_geom

Detailed Description

PHOLD model.

Member Typedef Documentation

InitEntityType

using spades::models::Phold::InitEntityType = InitEntityOp

InitMessageType

using spades::models::Phold::InitMessageType = InitMessageOp

ProcessType

using spades::models::Phold::ProcessType = ProcessOp

Constructor & Destructor Documentation

Phold()

spades::models::Phold::Phold ( )

explicit

Constructor.

{ read_parameters(); }

Here is the call graph for this function:

Member Function Documentation

geom()

const amrex::Geometry & spades::models::Phold::geom ( ) const

inlinenodiscard

{ return m_geom; }

identifier()

static std::string spades::models::Phold::identifier ( )

inlinestatic

Class identifier name.

Returns

class identifier

{ return "phold"; }

init_entity_op()

InitEntityType spades::models::Phold::init_entity_op ( ) const

inlinenodiscard

Initialize entity operator.

Returns

InitEntityType initialize entity operator

    {
        return m_init_entity_op;
    }

init_message_op()

InitMessageType spades::models::Phold::init_message_op ( ) const

inlinenodiscard

Initialize message operator.

Returns

InitMessageType initialize message operator

    {
        return m_init_message_op;
    }

process_op()

ProcessType spades::models::Phold::process_op ( ) const

inlinenodiscard

Message processing operator.

Returns

ProcessType message processing operator

{ return m_process_op; }

read_parameters()

void spades::models::Phold::read_parameters

(

)

Read user parameters.

{
 
    amrex::Array<amrex::Real, AMREX_SPACEDIM> plo{AMREX_D_DECL(0.0, 0.0, 0.0)};
    amrex::Array<amrex::Real, AMREX_SPACEDIM> phi{AMREX_D_DECL(0.0, 0.0, 0.0)};
    amrex::Array<int, AMREX_SPACEDIM> periodic{AMREX_D_DECL(0, 0, 0)};
    {
        amrex::ParmParse pp("geometry");
        pp.get("prob_lo", plo);
        pp.get("prob_hi", phi);
        pp.get("is_periodic", periodic);
    }
 
    amrex::Array<int, AMREX_SPACEDIM> ncells{AMREX_D_DECL(0, 0, 0)};
    {
        amrex::ParmParse pp("amr");
        pp.get("n_cell", ncells);
    }
 
    amrex::RealBox real_box;
    for (int n = 0; n < AMREX_SPACEDIM; n++) {
        real_box.setLo(n, plo[n]);
        real_box.setHi(n, phi[n]);
    }
 
    amrex::IntVect domain_lo(AMREX_D_DECL(0, 0, 0));
    amrex::IntVect domain_hi(
        AMREX_D_DECL(ncells[0] - 1, ncells[1] - 1, ncells[2] - 1));
 
    const amrex::Box domain(domain_lo, domain_hi);
    int coord = 0;
    m_geom.define(domain, &real_box, coord, periodic.data());
 
    m_process_op.m_dx = m_geom.CellSizeArray();
    m_process_op.m_dom = m_geom.Domain();
    m_process_op.m_plo = m_geom.ProbLoArray();
 
    amrex::Real lookahead = 1.0;
    amrex::Real lambda = 1.0;
    int entities_per_lp = 1;
    int messages_per_lp = 1;
    {
        amrex::ParmParse pp("spades");
        pp.query("lookahead", lookahead);
        pp.query("lambda", lambda);
        pp.query("entities_per_lp", entities_per_lp);
        pp.query("messages_per_lp", messages_per_lp);
    }
 
    m_process_op.m_lookahead = lookahead;
    m_process_op.m_lambda = lambda;
    m_process_op.m_entities_per_lp = entities_per_lp;
    m_init_entity_op.m_entities_per_lp = entities_per_lp;
    m_init_message_op.m_messages_per_lp = messages_per_lp;
    m_init_message_op.m_lambda = lambda;
    m_init_message_op.m_lookahead = lookahead;
}

Here is the caller graph for this function:

Member Data Documentation

m_geom

amrex::Geometry spades::models::Phold::m_geom

private

m_init_entity_op

InitEntityOp spades::models::Phold::m_init_entity_op

m_init_message_op

InitMessageOp spades::models::Phold::m_init_message_op

m_process_op

ProcessOp spades::models::Phold::m_process_op

---

The documentation for this class was generated from the following files:

• /home/runner/work/spades/spades/Source/Models/Phold.H
• /home/runner/work/spades/spades/Source/Models/Phold.cpp