amr_wind::MeshMap Class Reference

#include <MeshMap.H>

Inheritance diagram for amr_wind::MeshMap:

Collaboration diagram for amr_wind::MeshMap:

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 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< 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 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:

• /home/runner/work/amr-wind/amr-wind/amr-wind/core/MeshMap.H
• /home/runner/work/amr-wind/amr-wind/amr-wind/core/MeshMap.cpp