AMR-Wind  v0.1.0
CFD solver for wind plant simulations
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
amr_wind::MeshMap Class Referenceabstract

Abstract representation of different mesh mapping models. More...

#include <MeshMap.H>

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

Public Member Functions

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

Static Public Member Functions

static std::string base_identifier ()
 
- Static Public Member Functions inherited from amr_wind::Factory< MeshMap >
static std::unique_ptr< MeshMapcreate (const std::string &key, Args... args)
 Create an instance of the concrete subclass based on the runtime keyword. More...
 
static void print (std::ostream &os)
 Print a list of the valid subclasses registered to this base instance. More...
 

Protected Attributes

Fieldm_mesh_scale_fac_cc {nullptr}
 
Fieldm_mesh_scale_fac_nd {nullptr}
 
Fieldm_mesh_scale_fac_xf {nullptr}
 
Fieldm_mesh_scale_fac_yf {nullptr}
 
Fieldm_mesh_scale_fac_zf {nullptr}
 
Fieldm_mesh_scale_detJ_cc {nullptr}
 
Fieldm_mesh_scale_detJ_nd {nullptr}
 
Fieldm_mesh_scale_detJ_xf {nullptr}
 
Fieldm_mesh_scale_detJ_yf {nullptr}
 
Fieldm_mesh_scale_detJ_zf {nullptr}
 
Fieldm_non_uniform_coord_cc {nullptr}
 
Fieldm_non_uniform_coord_nd {nullptr}
 

Additional Inherited Members

- Public Attributes inherited from amr_wind::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()

amr_wind::MeshMap::~MeshMap ( )
overridedefault

Member Function Documentation

◆ base_identifier()

static std::string amr_wind::MeshMap::base_identifier ( )
inlinestatic

◆ create_map()

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

Construct mesh scaling field.

◆ declare_mapping_fields()

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

declare mesh mapping fields

Member Data Documentation

◆ m_mesh_scale_detJ_cc

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

◆ m_mesh_scale_detJ_nd

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

◆ m_mesh_scale_detJ_xf

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

◆ m_mesh_scale_detJ_yf

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

◆ m_mesh_scale_detJ_zf

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

◆ m_mesh_scale_fac_cc

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

◆ m_mesh_scale_fac_nd

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

◆ m_mesh_scale_fac_xf

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

◆ m_mesh_scale_fac_yf

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

◆ m_mesh_scale_fac_zf

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

◆ m_non_uniform_coord_cc

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

◆ m_non_uniform_coord_nd

Field* amr_wind::MeshMap::m_non_uniform_coord_nd {nullptr}
protected

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