Vlasiator ebf0dd394 on dev (v5.4.0 + 1054 commits)
Loading...
Searching...
No Matches
vmesh::MeshParameters Struct Reference

#include <velocity_mesh_parameters.h>

Public Member Functions

 MeshParameters ()

Public Attributes

std::string name
vmesh::LocalID max_velocity_blocks
Real meshLimits [6]
vmesh::LocalID gridLength [3]
vmesh::LocalID blockLength [3]
bool initialized
Real meshMinLimits [3]
Real meshMaxLimits [3]
Real blockSize [3]
Real cellSize [3]
Real gridSize [3]

Detailed Description

Wrapper for mesh parameters. The object wrapper reads one or more velocity meshes from the configuration file and stores them to the mesh vector MeshWrapper::velocityMeshes. The particle species store a mesh ID, which is an index to MeshWrapper::velocityMeshes. Many "get" functions in VelocityMesh are wrapper functions, which return the values stored in MeshParameters.

Definition at line 53 of file velocity_mesh_parameters.h.

Constructor & Destructor Documentation

◆ MeshParameters()

vmesh::MeshParameters::MeshParameters ( )
inline

Definition at line 68 of file velocity_mesh_parameters.h.

Member Data Documentation

◆ blockLength

vmesh::LocalID vmesh::MeshParameters::blockLength[3]

Number of phase-space cells per coordinate in block.

Definition at line 58 of file velocity_mesh_parameters.h.

◆ blockSize

Real vmesh::MeshParameters::blockSize[3]

Size of a block at base grid level.

Definition at line 64 of file velocity_mesh_parameters.h.

◆ cellSize

Real vmesh::MeshParameters::cellSize[3]

Size of a cell in a block at base grid level.

Definition at line 65 of file velocity_mesh_parameters.h.

◆ gridLength

vmesh::LocalID vmesh::MeshParameters::gridLength[3]

Number of blocks in mesh per coordinate at base grid level.

Definition at line 57 of file velocity_mesh_parameters.h.

◆ gridSize

Real vmesh::MeshParameters::gridSize[3]

Physical size of the grid bounding box.

Definition at line 66 of file velocity_mesh_parameters.h.

◆ initialized

bool vmesh::MeshParameters::initialized

If true, variables in this struct contain sensible values.

Definition at line 61 of file velocity_mesh_parameters.h.

◆ max_velocity_blocks

vmesh::LocalID vmesh::MeshParameters::max_velocity_blocks

Maximum valid block local ID.

Definition at line 55 of file velocity_mesh_parameters.h.

◆ meshLimits

Real vmesh::MeshParameters::meshLimits[6]

Velocity mesh bounding box limits vx_min,vx_max,...,vz_max.

Definition at line 56 of file velocity_mesh_parameters.h.

◆ meshMaxLimits

Real vmesh::MeshParameters::meshMaxLimits[3]

Maximum coordinate values of the grid bounding box.

Definition at line 63 of file velocity_mesh_parameters.h.

◆ meshMinLimits

Real vmesh::MeshParameters::meshMinLimits[3]

Minimum coordinate values of the grid bounding box.

Definition at line 62 of file velocity_mesh_parameters.h.

◆ name

std::string vmesh::MeshParameters::name

Name of the mesh (unique).

Definition at line 54 of file velocity_mesh_parameters.h.


The documentation for this struct was generated from the following file: