PLUTO  4.4-patch2
Functions
rbox.c File Reference

Collects various functions to operate on the RBox structure. More...

#include "pluto.h"

Functions

void RBoxCopy (RBox *box, Data_Arr Q_dst, Data_Arr Q_src, int nvar, char order)
 
void RBoxDefine (int ib, int ie, int jb, int je, int kb, int ke, int vpos, RBox *box)
 
void RBoxEnlarge (RBox *box, int di, int dj, int dk)
 
void RBoxSetDirections (RBox *box, int dir)
 

Detailed Description

Author
A. Mignone (migno.nosp@m.ne@t.nosp@m.o.inf.nosp@m.n.it)
Date
June 21, 2019

Function Documentation

◆ RBoxCopy()

void RBoxCopy ( RBox box,
Data_Arr  Q_dst,
Data_Arr  Q_src,
int  nvar,
char  order 
)

Copy 3D arrays on a RBox.

Parameters
[in]boxthe box where the copy takes place. A NULL pointer implies the total domain.
[out]Q_dstThe array where data is copied to.
[in]Q_srcThe array where data is copied from.
[in]nvarthe number of variables
[in]orderthe array ordering (either CONS_ARRAY or PRIM_ARRAY).

◆ RBoxDefine()

void RBoxDefine ( int  ib,
int  ie,
int  jb,
int  je,
int  kb,
int  ke,
int  vpos,
RBox box 
)
Parameters
[in]ibleftmost index in the X1 direction
[in]ierightmost index in the X1 direction
[in]jbleftmost index in the X2 direction
[in]jerightmost index in the X2 direction
[in]kbleftmost index in the X3 direction
[in]kerightmost index in the X3 direction
[in]vposthe variable location inside the cell (CENTER/X1FACE/.../X3FACE)
[out]boxpointer to a RBox structure

◆ RBoxEnlarge()

void RBoxEnlarge ( RBox box,
int  di,
int  dj,
int  dk 
)

Increase the size of the box by di, dj, dk in the three directions. Enlargment of the box in a given direction is permitted only if that dimension is enabled.

Parameters
[in]dileftmost index in the X1 direction
[in]djleftmost index in the X2 direction
[in]dkleftmost index in the X3 direction
[out]boxpointer to a RBox structure

◆ RBoxSetDirections()

void RBoxSetDirections ( RBox box,
int  dir 
)

Set normal, tangent and binormal directions while sweeping across a box using the BOX_TRANSVERSE_LOOP macro;

Parameters
[in,out]boxpointer to a RBox structure
[in]dirthe sweeping direction giving the normal direction and respect to which assign the tangent and binormal indices.