BlastFoam

https://github.com/synthetik-technologies/blastfoam
Admin
blastFoam is a library for single and multiphase compressible flow with application to...
Tokens:9,195
Snippets:153
Trust Score:7.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Create OpenFOAM Directory

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/INPUT.md

Creates the necessary directory structure for OpenFOAM installations.

```bash
mkdir -p $HOME/OpenFOAM
```

--------------------------------

### Generate Probes File with foamGet

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/tutorials/blastFoam/building3DWorkshop/README.md

Use the foamGet command to generate a basic probes file and a configuration file for setting output times. This is a convenient way to start adding probes to your case.

```bash
cd <root-case-directory>
foamGet probes # answer (1) to get the probes file and (2) to get a configuration file to set output times etc.
```

--------------------------------

### BlastFoam User Guide Citation

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/README.md

Citation for the blastFoam User Guide.

```text
J. Heylmun, P. Vonk, and T. Brewer, "blastFoam 6.0 User Guide", Synthetik Applied Technologies, LLC., 06-Aug-2020.
```

--------------------------------

### Append bashrc to Environment

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/INPUT.md

Adds the blastFoam environment setup script to the user's bash configuration.

```bash
echo "source $HOME/OpenFOAM/blastfoam/etc/bashrc" >> $HOME/.bashrc
```

--------------------------------

### blastFoam User Guide Citation

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/INPUT.md

Citation details for the blastFoam User Guide.

```bibtex
@misc{heylmun_blastfoamguide_2020,
	title = {{blastFoam version 3.0} {User} {Guide} },
	url = {https://github.com/synthetik-technologies/blastfoam},
	language = {English},
	publisher = {Synthetik Applied Technologies, LLC.},
	author = {Heylmun, Jeffrey and Vonk, Peter and Brewer, Timothy},
	month = oct,
	year = {2020}
}
```

--------------------------------

### BlastFoam User Guide BibTeX Citation

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/README.md

BibTeX entry for citing the blastFoam User Guide.

```bibtex
@misc{heylmun_blastfoamguide_2021,
	title = {{blastFoam version 6.0} {User} {Guide} },
	url = {https://github.com/synthetik-technologies/blastfoam},
	language = {English},
	publisher = {Synthetik Applied Technologies, LLC.},
	author = {Heylmun, Jeffrey and Vonk, Peter and Brewer, Timothy},
	month = aug,
	year = {2022}
}
```

--------------------------------

### Clone blastFoam Repository

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/INPUT.md

Downloads the blastFoam solver source code from GitHub.

```bash
git clone https://github.com/synthetik-technologies/blastfoam
```

--------------------------------

### Compile OpenFOAM

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/README.md

Compile the OpenFOAM-9 software after cloning the repository. This command sets up the bash environment and initiates the compilation process.

```bash
cd OpenFOAM-9
echo "source $HOME/OpenFOAM/OpenFOAM-9/etc/bashrc" >> ~/.bashrc
source etc/bashrc
./Allwmake > log.Allwmake 2>&1
```

--------------------------------

### Manually Define Pressure Probes in controlDict

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/tutorials/blastFoam/building3DWorkshop/README.md

Manually define pressure probes directly within the controlDict file. Specify probe locations and the fields to be recorded at each location.

```c++
functions
{

    pressureProbes
    {
        type            probes;
        functionObjectLibs ("libsampling.so");
        writeControl    timeStep;
        writeInterval   1;
        probeLocations
        (
			// probe locations in ( x y z ) format, unlimited number -- needs to be inside the domain!
			( 1.999 0.001 0.5)
			// ( 0 0 0 ) // etc... 
        );
        fields
        (
            p // fields you want at each probe location: p U T rho etc. 
        );
    }

};

```

--------------------------------

### Include Probes Function in controlDict

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/tutorials/blastFoam/building3DWorkshop/README.md

Include the system/probes file in the functions{}; section of the controlDict file to load the probes. This is an alternative to manually defining probes.

```c++
functions
{
	#includeFunc "probes"; // this will load the system/probes file that was created with the $ foamGet probes command
};

```

--------------------------------

### Load bash Environment

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/README.md

Load the bash environment, either from .bashrc or .zshrc, to make the blastFoam commands available.

```bash
source $HOME/.bashrc
# or if using zsh:
source $HOME/.zshrc
```

--------------------------------

### Clone OpenFOAM-9 Repository

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/README.md

Clone the OpenFOAM-9 repository to your local machine. This is a prerequisite for compiling OpenFOAM.

```bash
cd $HOME/OpenFOAM
git clone https://github.com/OpenFOAM/OpenFOAM-9.git
```

--------------------------------

### Compile blastFoam Solver

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/INPUT.md

Compiles the blastFoam solver. Use the -j flag for parallel compilation.

```bash
./Allwmake
```

--------------------------------

### Compile blastFoam

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/README.md

Compile the blastFoam library. The -j flag enables parallel compilation for faster build times.

```bash
./Allwmake -j
```

--------------------------------

### BlastFoam Citation

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/README.md

Use this citation when referencing the blastFoam solver in your work.

```text
blastFoam: An OpenFOAM Solver for Compressible Multi-Fluid Flow with Application to High-Explosive Detonation. Synthetik Applied Technologies, LLC., 2020.
```

--------------------------------

### blastFoam Software Citation

Source: https://github.com/synthetik-technologies/blastfoam/blob/master/INPUT.md

Citation details for the blastFoam software, suitable for academic use.

```bibtex
@software{blastfoam,
	title = {{blastFoam}: A Solver for Compressible Multi-Fluid Flow with Application to High-Explosive Detonation},
	url = {https://github.com/synthetik-technologies/blastfoam},
	publisher = {Synthetik Applied Technologies, {LLC}.},
	date = {2020-04-13}
}
```
Tokens:
Raw