AMR-Solver  1.0
Block-based Octree AMR grid flow solver
myOctree::Field Class Reference

Template class for any scalar field variable in the domain. More...

#include <field.h>

Public Member Functions

 Field (int N_x, int N_y, int N_z, std::string info)
 
 Field ()
 
 Field (const Field &obj)
 
 ~Field ()
 
void set_field (double)
 

Public Attributes

double *** val
 
std::string name
 
FieldBc bc [3][2]
 
Size
int Nx
 
int Ny
 
int Nz
 
int N
 

Detailed Description

Template class for any scalar field variable in the domain.

Usage: Field object(nx,ny,nz); Parameters are the number of cells along x, y and z (including the padding) which usually remains same for all the blocks in the mesh. Padding represents extra layer of cells at all the sides of the block, which acts as ghost cells at the block boundaries or buffer cells at the processor boundaries. New objects of this class are defined in the constructors of Block class and the pointers to these objects are members of the Block class.

Definition at line 11 of file field.h.

Constructor & Destructor Documentation

myOctree::Field::Field ( int  N_x,
int  N_y,
int  N_z,
std::string  info 
)

Parametrized constructor with initialization fields

Definition at line 5 of file field.cpp.

myOctree::Field::Field ( )

Default constructor

Definition at line 21 of file field.cpp.

myOctree::Field::Field ( const Field obj)

Copy constructor

Definition at line 38 of file field.cpp.

myOctree::Field::~Field ( )

Destructor

Definition at line 65 of file field.cpp.

Member Function Documentation

void myOctree::Field::set_field ( double  value)

Function to set the given value in the field

Definition at line 80 of file field.cpp.

Member Data Documentation

FieldBc myOctree::Field::bc[3][2]

Field boundary conditions

Definition at line 22 of file field.h.

int myOctree::Field::N

Definition at line 18 of file field.h.

std::string myOctree::Field::name

Field name

Definition at line 21 of file field.h.

int myOctree::Field::Nx

Definition at line 17 of file field.h.

int myOctree::Field::Ny

Definition at line 17 of file field.h.

int myOctree::Field::Nz

Definition at line 17 of file field.h.

double*** myOctree::Field::val

3D array for storing field varible values at the cells

Definition at line 20 of file field.h.


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