MeshMap Class Reference

Kynema-SGF API: kynema_sgf::MeshMap Class Reference
Kynema-SGF API v0.1.0
CFD solver for wind plant simulations
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
kynema_sgf::MeshMap Class Referenceabstract

#include <MeshMap.H>

Inheritance diagram for kynema_sgf::MeshMap:
[legend]
Collaboration diagram for kynema_sgf::MeshMap:
[legend]

Public Member Functions

 ~MeshMap () override=default
void declare_mapping_fields (const CFDSim &, int)
 declare mesh mapping fields
virtual void create_map (int, const amrex::Geometry &)=0
 Construct mesh scaling field.
Public Member Functions inherited from kynema_sgf::Factory< MeshMap >
virtual ~Factory ()=default

Static Public Member Functions

static std::string base_identifier ()
Static Public Member Functions inherited from kynema_sgf::Factory< MeshMap >
static std::unique_ptr< MeshMap > create (const std::string &key, Args... args)
static void print (std::ostream &os)

Protected Attributes

Field * m_mesh_scale_fac_cc {nullptr}
Field * m_mesh_scale_fac_nd {nullptr}
Field * m_mesh_scale_fac_xf {nullptr}
Field * m_mesh_scale_fac_yf {nullptr}
Field * m_mesh_scale_fac_zf {nullptr}
Field * m_mesh_scale_detJ_cc {nullptr}
Field * m_mesh_scale_detJ_nd {nullptr}
Field * m_mesh_scale_detJ_xf {nullptr}
Field * m_mesh_scale_detJ_yf {nullptr}
Field * m_mesh_scale_detJ_zf {nullptr}
Field * m_non_uniform_coord_cc {nullptr}
Field * m_non_uniform_coord_nd {nullptr}

Additional Inherited Members

Public Attributes inherited from kynema_sgf::Factory< MeshMap >
friend Base

Detailed Description

Abstract representation of different mesh mapping models

This class defines an abstract API that represents the notion of some mesh mapping that will be used to scale the mesh. The most common use-case for this class is to perform RANS simulations.

Constructor & Destructor Documentation

◆ ~MeshMap()

kynema_sgf::MeshMap::~MeshMap ( )
overridedefault

Member Function Documentation

◆ base_identifier()

std::string kynema_sgf::MeshMap::base_identifier ( )
inlinestatic

◆ create_map()

virtual void kynema_sgf::MeshMap::create_map ( int ,
const amrex::Geometry &  )
pure virtual

Construct mesh scaling field.

◆ declare_mapping_fields()

void kynema_sgf::MeshMap::declare_mapping_fields ( const CFDSim & sim,
int nghost )

declare mesh mapping fields

Member Data Documentation

◆ m_mesh_scale_detJ_cc

Field* kynema_sgf::MeshMap::m_mesh_scale_detJ_cc {nullptr}
protected

◆ m_mesh_scale_detJ_nd

Field* kynema_sgf::MeshMap::m_mesh_scale_detJ_nd {nullptr}
protected

◆ m_mesh_scale_detJ_xf

Field* kynema_sgf::MeshMap::m_mesh_scale_detJ_xf {nullptr}
protected

◆ m_mesh_scale_detJ_yf

Field* kynema_sgf::MeshMap::m_mesh_scale_detJ_yf {nullptr}
protected

◆ m_mesh_scale_detJ_zf

Field* kynema_sgf::MeshMap::m_mesh_scale_detJ_zf {nullptr}
protected

◆ m_mesh_scale_fac_cc

Field* kynema_sgf::MeshMap::m_mesh_scale_fac_cc {nullptr}
protected

◆ m_mesh_scale_fac_nd

Field* kynema_sgf::MeshMap::m_mesh_scale_fac_nd {nullptr}
protected

◆ m_mesh_scale_fac_xf

Field* kynema_sgf::MeshMap::m_mesh_scale_fac_xf {nullptr}
protected

◆ m_mesh_scale_fac_yf

Field* kynema_sgf::MeshMap::m_mesh_scale_fac_yf {nullptr}
protected

◆ m_mesh_scale_fac_zf

Field* kynema_sgf::MeshMap::m_mesh_scale_fac_zf {nullptr}
protected

◆ m_non_uniform_coord_cc

Field* kynema_sgf::MeshMap::m_non_uniform_coord_cc {nullptr}
protected

◆ m_non_uniform_coord_nd

Field* kynema_sgf::MeshMap::m_non_uniform_coord_nd {nullptr}
protected
The documentation for this class was generated from the following files:
  • /home/runner/work/kynema-sgf/kynema-sgf/src/core/MeshMap.H
  • /home/runner/work/kynema-sgf/kynema-sgf/src/core/MeshMap.cpp
Generated by doxygen 1.14.0